허원철의 개발 블로그

클린 코드 (3) 본문

clean code & refactoring

클린 코드 (3)

허원철 2017.03.26 23:24

이번 글은 클린코드에 대한 세번째 글입니다.


 

주석
 
클린 코드를하는데 주석은 걸림돌이 될 수 있습니다. 왜냐하면 코드는 진화하는데 주석은 오랫동안 방치되는 경우가 대부분입니다. 
 
1) 주석보단 코드로 의도를 표현합니다. (메소드명으로 행위를 명확하게 전달 합니다.)

2) 좋은 주석
 - 법적인 주석 (라이센스 등)
 - 정보를 제공하는 주석
 - 의도를 명료하게 밝히는 주석
 - 결과를 경고하는 주석
 - todo 주석
 - javadocs

3) 나쁜 주석
 - 중복 주석
 - 오해할 여지가 있는 주석
 - 의무적인, 이력을 남긴 주석
 - 함수나 변수로 표현할 수 없으면 주석을 달지 않습니다. 
 - 너무 많은 정보
 - 모호한 관계
 
 
형식 맞추기
 
1) 적절한 행을 유지합니다.
- 위에서 아래로 서술적으로 쓰도록 합니다. (책에서는 내려가기 규칙이라 합니다.)
- 비슷한 개념의 파일은 가까이 둡니다. (메뉴별 패키지화, 모듈별 패키지화)

2) 가로 형식 맞춰춥니다.
- 가로 정렬(선언부가 길다면..)
 
 
객체와 자료구조
 
1) 객체는 직접적인 반환보다는 추상적인 반환이 좋습니다.

2) 때로는 절차적인 코드가 좋을 때도 있습니다.(물론 예외적인 상황입니다.)

3) 디미터 법칙을 적용합니다
- 모듈은 자신을 조작하는 객체의 속사정을 몰라야 한다.
 


'clean code & refactoring' 카테고리의 다른 글

클린 코드 (3)  (0) 2017.03.26
클린 코드 (2)  (0) 2017.03.26
클린 코드 (1)  (0) 2017.03.26
0 Comments
댓글쓰기 폼