[읽코좋코] 주석의 문장을 명확하게

# 이 URL을 전에 이미 방문했는지에 따라서 다른 우선순위를 부여한다.

- 이정도 문장은 나쁘지 않다 하지만 좀 더 좋은 문장으로 바꿔본다면

 

# 전에 방문하지 않은 URL에 높은 우선순위를 부여하라

- 문장이 더 간단하고 짧고, 직접적이고 "URL에 높은 우선순위가 부여된다"는 사실까지 설명하여 더 좋은 문장이 되었다.

 

//이 파일에 담긴 줄 수를 반환한다
int CountLines(string filename){...}

- 위 주석엔 '줄'이 어떤 것인지 명확하지 않다.

- '\n'로 구분하는지, 빈파일은 줄이 0개인지, 'hello'는 줄이 1인지 0인지 등 명확하게 알수가 없다.

 

//파일안에 새 줄을 나타내는 바이트('\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){...}

- 이런식으로 간단한 입출력 예로 문장을 대신하여 이해를 더 해줄수 있다.

- 물론 지나치게 단순한 예제는 큰 의미가 없기 때문에 주의해야한다.