lou@blog $ _

Java 수업때 가장 등한시했던 부분이 바로 Javadoc이었는데 이제 정말 필요한 상황이 왔다. 코드를 작성하는 시간보다 코드를 다시 보고, 다른사람에게 설명하는데 쓰는시간이 배로 많다. 잘 작성된 Javadoc은 이런 비효율적인 일을 줄여줄 수 있다. 기계인간 Johngrib님의 포스팅과 javadoc 문서를 참고했다. 예시 코드는 Android Source Code다. 작성 원칙 코드의 역할을 3초안에 파악할 수 있도록하는 것이 목적이다. 가독성이 중요하다. 세부 구현은 언제든지 바뀔 수 있으므로 구현에 대한 내용은 적지 않는다. 루프를 돌아서 반환한다던가 하는 설명 @deprecated /** * Main Sidecar interface definition that will be used by t..

지난 2주는 아주 고통스러웠다. 긴 연휴가 끝나고 마법처럼 이슈들이 빵빵 터졌다. 마치 잘 쉬었냐고 인사하는 것처럼... 긴 이슈의 터널을 통과하면서 "주석은 중요하다"라는 것이 뼈저리게 느껴졌다. (모든 것이 주석때문은 아니었지만) 물론, 주석은 해가 되기도 한다. - 별다른 주석 없이 주석처리된 코드 - 코드와 맞지 않는 Outdated된 주석 - 쓸모없는(redundant) 주석 Clean Code 열풍과 함께 주석 없는 코드가 완전히 대세가 되었다. "주석 없이도 읽힐 수 있는 코드가 잘 짜여진 코드다"라는 말 한번쯤 들어보셨으리라 생각한다. 나도 그에 동의했고, 되도록이면 주석을 적지 않으려고 했다. 마틴 파울러 선생님이 틀렸다고는 생각하지 않지만, 내가 틀렸다고는 생각한다. 내가 쓴 코드가 정..