1.
/// Get Weight of x with unit kg.
double foobar(MyClass x);
로 할바엔 그냥 첨부터
double getWeightKg(Person p);
로 하면 좋을것 같다.
2.
// This is get perimeter
x = M_PI * 2 * r;
어쩌다가 급하게 일이 생겨 주석 변경을 깜빡하고 둘레 대신 넓이를 구해야 해서 코드를 수정했다고 하자.
// This is get perimeter
x = M_PI * r * r;
누구나 깜빡할 수 있다. 하지만 이건 컴파일 에러는 나지 않는다. 그렇다. 코드는 거짓말 하지 않지만 주석은 `의도치 않게` 거짓말 할 수 있다.
(물론 True = False나 Greek question ; 같은건 논외;)
3.
너무 길고 복잡해져도 주석이 필요 없을까?
내 생각은 그렇다. 주석 한줄 더 달 시간에 이름이나 예쁘게 짓고 문서랑 예제나 더 만들어줬으면 좋겠다.
댓글 0