좋은 코드에는 주석이 없다?
💡 10분 안에 이런 내용을 알려드려요!
- 코딩 시 주석을 줄이는 효과적인 방법
- 동료 개발자를 배려하는 주석 쓰기 노하우
※ [개발자의 글쓰기] 시리즈의 콘텐츠입니다 ※
* 본 콘텐츠는 2019년 10월에 발간된 <개발자의 글쓰기>의 본문 내용을 퍼블리의 시선으로 발췌해 구성했습니다.
코딩을 할 때 사실 이름을 잘 지으면 주석을 대폭 줄일 수 있다. 주석이 할 일을 이름이 대신하기 때문이다. 다음 예를 살펴보자.
주석으로 '변수 h의 값을 480으로 지정한 이유'를 썼다. 이렇게 주석을 쓴 이유는 변수 h가 '스크린의 최대 높이'라는 의미를 제대로 전달하지 못하기 때문이다. 처음부터 변수 이름을 최대 높이로 지으면 의미가 충분히 전달되므로 주석을 쓸 필요가 없다.
예를 하나 더 보자.
'levelUser()'라는 함수를 설명하기 위해 주석으로 '사용자 유형을 분류해서 등급 값을 리턴함'이라고 썼다. 이런 경우라면 처음부터 주석의 내용을 함수 이름으로 지으면 된다.
처음부터 주석 없이 코딩하는 습관을 들이자
JSON(JavaScript Object Notation)에는 원래 주석을 달 수 없었다. JSON 자체가 함수 없이 키(key)와 값(value)으로만 이뤄지기 때문이다. 그래서 키 이름을 잘 정하면 주석을 쓸 이유가 없다.
JSON5에 주석을 단 다음 예를 살펴보자.
먼저 첫 번째 주석을 살펴보자.
키가 OK고, 값은 true나 false다. 처음부터 키를 'isRequestSuccess'로 정하면 '요청에 대한 성공'이라는 말이 필요하지 않다. 'is' 접두사 자체가 true 아니면 false를 반환하므로 true가 성공이고 false가 실패라는 말도 필요하지 않다.
두 번째 주석은 JSON 문법을 설명한다. 이 코드를 보는 사람이 JSON 문법의 기초도 모르고 읽지는 않을 것이다. 주석이 언어의 문법까지 일일이 설명할 필요는 없다. 정말로 필요하다면 코드 사이가 아니라 코드를 시작하기 전에 알려줘야 한다.
