반응형
comment
-
3. 주석Technique/Readable Code 2015. 12. 9. 14:28
주석을 다는 목적은 코드를 작성하는 사람이 알고 있는 정보를 코드를 읽는 사람에게 전달하는 것 이다.코드에서 명확하게 드러나지 않는 내용이 무엇인지 파악하고 주석으로 처리하는 것 ■ 설명하지 말아야 할 것 - 코드 자체에서 재빨리 도출될 수 있는 사실 - 나쁜 함수명과 같이 나쁘게 작성된 코드를 보정하려고 애쓰는 주석 그렇게 할 시간에 코드를 수정해라 ■ 코드에 기록 해야하는 것 - 코드가 특정한 방식으로 작성된 이유를 설명해주는 내용 ( 감독의 설명 ) - 코드에 담긴 결함, TODO 혹은 xxxx같은 표시를 사용하라 - 특정 상수가 특정 값을 가지게 된 사연 - 코드를 읽는 사람이 자기가 작성한 코드의 어느 부분을 보고 뭐라고? 라는 생각을 할지 예측해보고, 그부분에 주석을 달 것 - 평범한 사람이 ..