Part 6. 명확하고

Part 6

명확하고 간결한 주석 달기

주석에 대한 좋은 정보들이 담겨있다.

함수의 동작을 실제로 할 수 있는 한도 내에서 최대한 명확하게 설명하라.

신중하게 선택된 입/출력 예로 주석을 서술하라.

코드가 가진 의도를 너무 자세한 내용이 아니라 높은 수준에서 개괄적으로 설명하라.

많은 의미를 함축하는 단어로 주석을 간단하게 만들라.

. 주석을 간결하게 하라

// int는 CategoryType이다.

// 내부 페어는 첫 번째 float는 'score'이다.

// 두 번째는 'weight'이다

// CategoryType -> (score, weight)

. 동작을 명확하게 설명하라

// 이 파일에 담긴 줄 수를 반환한다.

int CountLines(string filename)

// 파일 안에 새 줄을 나타내는 바이트('/n')가 몇 개 있는지 센다.

int CountLines(string filename)

. 코너케이스를 설명해주는 입/출력 예를 사용하라

// 입력된 'src'의 'chars'라는 접두사와 접미사를 제거한다.

String Strip(String src, String chars)

// 예 : Strip("abba/a/ba", "ab")은 "/a/"를 반환한다.

String Strip(String src, String chars)

. 코드의 의도를 명시하라

// 리스트를 역순으로 반복한다.

// 각 가격을 높은 값에서 낮은 값 순으로 나타낸다.

-> 정렬에 오류가 있었다면, 주석을 읽고 높고 낮음의 차이를 금방 이해할 수 있을 것이다.

읽기 좋은 코드가 좋은 코드다.

더스틴 보즈웰, 트레버 파우커 지음 - 임백준 옮김

한빛미디어