2022-04-18 @이영훈
주석
나쁜 코드에 주석을 달지 마라. 새로 짜라.
- 브라이언 W. 커니핸, P.J. 플라우거
사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다.
주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
코드 품질이 나쁘면 주석을 다는 게 아니라 
코드를 정리해야 한다.
코드를 정리해야 한다.코드로 의도를 표현하라
많은 경우 주석을 달려는 설명을 함수로 만들어 표현해도 충분하다
// ❌ bad case
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
// 🟢 better case
if (employee.isEligibleForFullBenefits())
Java
복사
좋은 주석
다음은 글자값을 하는 주석 몇 가지 경우입니다. 하지만 정말로 좋은 주석은, 주석을 달지 않는 방법을 찾아낸 주석입니다.
법적인 주석
소스파일 첫 머리에 저작권 정보와 소유권 정보를 기입하는 경우
// Copyright (C) 2019~2022 by Leedo Corp. All rights reserved.
// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.
Java
복사
정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하다
// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();
Java
복사
( 이걸 주석으로 왜 달아야 하는 지 저는 이해가 안됩니다)
이걸 주석으로 왜 달아야 하는 지 저는 이해가 안됩니다)// kk:mm:ss EEE, MMM dd, yyyy 형식
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*"
);
Java
복사
시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하다. 그러면 주석이 필요 없어진다.
(이 정도는 주석을 붙이는 게 가독성과 이해도 측면에서 더 좋다고 생각합니다. 그렇지만 변수명을 더 개선할 수 있으면 한 번 생각한 뒤에 주석을 붙일 거 같습니다)
의도를 설명하는 주석
결정에 깔린 의도를 설명하는 주석입니다.
public int compareTo(Object o) {
if (o instanceof WikiPagePath) {
WikiPagePath p = (WikiPagePath) o;
String compressedName = StringUtil.join(names, "");
String compressedArgumentName = StringUtil.join(p.names, "");
return compressedName.compareTo(compressedArgumentName);
}
return 1; // 오른쪽 유형이므로 정렬 우선순위가 높다
}
Java
복사
의미를 명료하게 밝히는 주석
인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
@Test
public void testCompareTo() throws Exception {
WikiPagePath a = PathParser.parse("PageA");
WikiPagePath ab = PathParser.parse("PageA.PageB");
assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) != 0); // a != b
assertTrue(a.compareTo(b) == -1); // a < b
}
Java
복사
결과를 경고하는 주석
다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다
특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석이다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {
writeLinesToFile(10_000_000);
response.setBody(testFile);
response.readyToSend(this);
String responseString = output.toString();
assertSubString("Content-Length: 10000000", responseString);
assertTrue(bytesSent > 10_000_000);
}
Java
복사
요즘은 JUnit을 사용하여 @Ignore("실행이 너무 오래 걸린다.") 로 사용합니다
다음은 주석이 아주 적절한 예제입니다.public static SimpleDateFormat makeStandardHttpDateFormat() {
// SimpleDateFormat은 스레드 세이프하지 않습니다
// 따라서 각 인스턴스를 독립적으로 생성해야 합니다
SimpleDateFormat df = new SimpleDateFormat("EEEE, dd MMM yyyy HH:mm:ss z");
df.setTimeZone(TimeZone.gettimeZone("GMT");
return dt;
}
Java
복사
TODO 주석
때로는 ‘앞으로 할 일’을 //TODO 주석으로 남겨두면 편하다.
TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술합니다. 더 이상 필요없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용합니다.
다음은 함수를 구현하지 않은 이유와 미래 모습을 //TODO 주석으로 설명한 예제입니다
// TODO: 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception {
return null;
}
Java
복사
중요성을 강조하는 주석
대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용합니다
// 여기서 trim은 중요합니다. trim 함수는 문자열에서 시작 공백을 제거합니다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문입니다
String listItemContent = match.group(3).trim();
new ListItemWidge(this, listItemContent, this.level + 1);
return buildList(text.substring(match.end()));
Java
복사
제가 주석을 사용하는 경우
1.
외부 라이브러리를 가져다 쓰면서 발생하는 코드상의 로직일 때 (즉, 해봐야 이해가 되는 코드일 때)
class OffsetDateTimeConverter : DynamoDBTypeConverter<Date, OffsetDateTime> {
// OffsetDateTime -> Date
// Entity -> DynamoDB
override fun convert(offsetDateTime: OffsetDateTime): Date {
return Date.from(offsetDateTime.toInstant())
}
// Date -> OffsetDateTime
// DynamoDB -> Entity
override fun unconvert(date: Date): OffsetDateTime {
return date.toInstant().atOffset(ZoneOffset.UTC)
}
}
Java
복사
2.
회사 비즈니스 로직상 필요한 로직일 때 (이것도 해봐야 아는 코드일 때)
a.
되도록 리팩토링을 해서 함수나 클래스로 뺄 수 있으면 빼려고 노력합니다
3.
Todo 주석
a.
향후 개발되어야 할 부분, 로직이 발전되어야 할 방향성, 더 좋은 개발 방향이나 라이브러리를 기입, 리팩토링 아이디어 등을 기록합니다
4.
테스트 코드에서 의미를 분명히 할 때 (적정선의 trade-off)
a.
테스트 코드이기 때문에 필요 이상의 노력을 들이기 보다는 적당한 레벨에서 리팩토링을 하고 해당 비즈니스 로직은 주석으로 설명을 합니다