[클린코드 작성하기] 주석 & 포맷팅

주석

모든 내용을 주석으로 넣게되면 코드가 지저분 해짐.

네이밍을 잘하면 충분히 해결 가능

네이밍으로 표현할 수 없는 영역을 주석으로 표현하기 바람.

 

1. 법적인 정보 담을 때 : Copyright등등..
2. 의도를 명확하게 설명할 때 : 함수내 알고리즘 설명할 때, 
3. 중요성을 강조할 때 
4. 결과를 경고할 때

관용적으로 사용되는 키워드

TODO : 당장은 아니지만 다음에 해야할 때 ( TODO@sihyeon : 객체의 책임 더 분리하기 등등 )

FIXME : 치명적인 에러를 발생하는 코드는 아니지만 수정해야할 때 ( 반복문의 depth를 줄이기 )

XXX : 더 생각해볼 필요가 있을 때 

 

포맷팅

Vertical Formatting ( 파일 라인이 길어지는 경우 )

 : 한 파일에 코드를 다 넣지 말고, 개념에 맞게 파일을 나눠서 사용.

 : 다른 개념의 코드는 Spacing으로 분리하기, 비슷한 개념의 코드는 붙여서 사용하기

 : 논리적으로 다른 로직이 돌아갈 때는 엔터 쳐서 구분.

 

Horizontal Formatting ( 한 줄에 너무 길게 하면 읽기 힘듦 )

 : 한줄에 코드를 다 넣기보단 변수 등을 활용해서 가독성 높이기

 : 네이밍 잘해서 길이 줄이기