<div id="readability-page-1" class="page"><cite>otrodevym</cite>
 2021. 12. 13. 00:00
 <div>
 <figure data-ke-mobilestyle="widthOrigin" data-origin-width="701" data-origin-height="924">
 
 <img src="https://k.kakaocdn.net/dn/dCBGvS/btrnCALF1yu/6B22U0iDpbFx9722zQmBTK/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-origin-width="701" data-origin-height="924">
 
 
</figure>
<h2 data-ke-size="size26">4장, 주석</h2>
나쁜 코드에 주석을 달지 마라, 새로 짜라 - 브라이언 W. 커니핸, P.J. 플라우거
잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.
주석은 쉰들러 리스트가 아니다. 주석은 '순수하게 선하지' 못하다.
사실상 주석은 기껏해야 필요악이다.
프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라.
우리는 코드로 의도를 표현하지 못해서, 실패를 만회하기 위해 주석을 사용한다.
주석은 오래될수록 코드에서 멀어진다.
코드는 변화고 진화하고 여기저기 옮겨다니고 조각이 나뉘고 합치면서 괴물로 변하지만 언제나 진실은 코드다. 주석은 이를 따라가지 못한다.
<h3 data-ke-size="size23">주석은 나쁜 코드를 보완하지 못한다.</h3>
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
<h3 data-ke-size="size23">코드로 의도를 표현하라!</h3>
<pre><code>// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags &amp; HOURLY_FLAG) &amp;&amp; (employee.age &gt; 65))

// 위에보다 아래가 더 낫지 않은가?
if (employee.isEligibleForFullBenefits())
</code></pre>
<h3 data-ke-size="size23">좋은 주석</h3>
어떤 주석은 필요하거나 유익하다. 지금부터 글자 값을 한다고 생각하는 주석 몇 가지를 소개한다.
하지만 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을! 명심하자!
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
정보를 제공하는 주석
<pre><code>// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pateern timeMatcher = Pattern.compile(
"\\\\d*:\\\\d*:\\\\d* \\\\w*, \\\\w* \\\\d*, \\\\d*");
</code></pre>
이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하다.
의도를 설명하는 주석
<pre><code>// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i &lt; 25000; i++) {
	WidgetBuilderthread widgetBuilderThread = new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
	Thread thread = new Thread(widgetBuilderThread);
	thread.start();
}
	aseertEquals(false, failFlag.get());	
}
</code></pre>
의도는 드러나지만 저자는 해결방법으로 주석 작성에 동의하지 않을지도 모르겠다.
의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
<pre><code>aseertTrue(a.compareTo(a) == 0); // a == a
aseertTrue(a.compareTo(b) != 0); // a != b
</code></pre>
주석이 올바른지 검증하기 쉽지 않다.
경과를 경고하는 주석
<pre><code>// 여유 시간이 충분하지 않다면 실행하지 마십시오.
</code></pre>
요즘은 @Ignore("실행이 오래 걸린다." 속성을 이용해 테스트 케이스를 꺼버린다.
<pre><code>public static SimpleDateFormat makeStandardHttpDateFormat() {
	// SimpleDateFormat은 스레드에 안전하지 못하다.
	// 따라서 각 인스턴스를 독립적으로 생성해야 한다.
	SimpleDateFormat df = new SimpleDateFormat("");
	df.setTimeZone(TimeZone.getTimeZone("GMT"));
	return df;
}
</code></pre>
더 나은 해결책이 있다고 불평할지도 모르겠지만 여기서는 주석이 아주 합리적이다.
프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면한다.
TODO 주석
TODO 주석은 프로그래머에게 필요한 주석이다.
당장 구현하기 어려운 업무를 기술한다.
중요성을 강조하는 주석
중요성을 강조하고 싶을 때 사용한다.
공개 API에서 Javadoc
표준 자바 라이브러리에서 사용한 Javadoc이 좋은 예다.
<h3 data-ke-size="size23">나쁜 주석</h3>
대다수 주석이 이 범주에 해당한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 않는다.
주절거리는 주석
이해가 되지 않는 주석을 이해하기 위해 답을 알아내려면 다른 코드를 뒤져보는 수밖에 없다
같은 이야기를 중복하는 주석
헤더에 달린 주석을 중복한다면 읽는 시간이 더 오래 걸린다.
오해할 여지가 있는 주석
주석에 담긴 '살짝 잘못된 정보'로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.
의무적으로 다는 주석
모든 함수에 Javadocs를 담거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
이력을 기록하는 주석
과거에는 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다. 지금은 완전히 제거하는 편이 좋다.
있으나 마나 한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
무서운 잡음
때로는 Javadocs도 잡음이다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
<pre><code>// 전역 목록 &lt;smodule&gt;에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (semodule.getDependSubsystems().contains(subSysMod.getSubSystem())

// 위 주석을 없애고 코드로 표현하면
ArrayList moduleDependees = smodule.getDependSubsystem();
String outSubSystem = subSysMod.getSubSystem();
if(moduleDependees.contains(ourSubSystem))
</code></pre>
위치를 표시하는 주석
소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
<pre><code>// Actions ///////////////////////////////////////////
</code></pre>
닫는 괄호에 다는 주석
중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 (우리가 선호하는) 작고 캡슐화된 함수에는 잡음일 뿐이다.
공로를 돌리거나 저자를 표시하는 주석
소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요가 없다.
<pre><code>// 릭이 추가함
</code></pre>
주석으로 처리한 코드
주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
이유가 있어 남겨놓으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.
1960년대에는 주석으로 처리한 코드가 유용했었으나 현재는 소스 코드 관리 시스템을 사용해왔기에 잃어버릴 염려는 없다.
HTML 주석
소스 코드에서 HTML 주석은 혐오 그자체다.
전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
<pre><code>/** 
	* 적합성 테스트가 동작하는 포트: 기본값은 &lt;b&gt;8082&lt;/b&gt;.
	*
	* @param fitnessePort
	*/
public void setFitnessePort(int fitnessePort) {
	this.fitnessePort = fitnessProt;
}
</code></pre>
함수 자체가 포트 기본값(&lt;b&gt;8082&lt;/b&gt;)을 전혀 통제할 수 없다. 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없다.
너무 많은 정보
주석에다 흥비로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
<pre><code>/** 
	* 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
	* 그리고 헤더 정보를 위해 200바이트를 더한다.
	*/
this.pngBytes = new byte[**this.width + 1) * this.height * 3) + 200];
</code></pre>
필터 바이트란 무엇인가??? +1과 관련이 있는건지 *3과 관련이 있는건지 알 수 없다.
200을 추가하는 이유는 무엇인지 설명이 부족하다.
함수 헤더
짧은 함수는 긴 설명이 필요 없다.
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
<pre id="code_1639192798612" data-ke-language="shell" data-ke-type="codeblock"><code>예제

4-7 예제는 책 참고</code></pre>
 
 
 </div></div>

미니 블로그 : 메모하는 습관

otrodevym

4장, 주석
나쁜 코드에 주석을 달지 마라, 새로 짜라 - 브라이언 W. 커니핸, P.J. 플라우거
잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.
주석은 쉰들러 리스트가 아니다. 주석은 '순수하게 선하지' 못하다.
사실상 주석은 기껏해야 필요악이다.
프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라.
우리는 코드로 의도를 표현하지 못해서, 실패를 만회하기 위해 주석을 사용한다.
주석은 오래될수록 코드에서 멀어진다.
코드는 변화고 진화하고 여기저기 옮겨다니고 조각이 나뉘고 합치면서 괴물로 변하지만 언제나 진실은 코드다. 주석은 이를 따라가지 못한다.
주석은 나쁜 코드를 보완하지 못한다.
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
코드로 의도를 표현하라!
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
// 위에보다 아래가 더 낫지 않은가?
if (employee.isEligibleForFullBenefits())
좋은 주석
어떤 주석은 필요하거나 유익하다. 지금부터 글자 값을 한다고 생각하는 주석 몇 가지를 소개한다.
하지만 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을! 명심하자!
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
정보를 제공하는 주석
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pateern timeMatcher = Pattern.compile(
"\\\\d*:\\\\d*:\\\\d* \\\\w*, \\\\w* \\\\d*, \\\\d*");
이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하다.
의도를 설명하는 주석
// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i < 25000; i++) {
	WidgetBuilderthread widgetBuilderThread = new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
	Thread thread = new Thread(widgetBuilderThread);
	thread.start();
}
	aseertEquals(false, failFlag.get());	
}
의도는 드러나지만 저자는 해결방법으로 주석 작성에 동의하지 않을지도 모르겠다.
의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
aseertTrue(a.compareTo(a) == 0); // a == a
aseertTrue(a.compareTo(b) != 0); // a != b
주석이 올바른지 검증하기 쉽지 않다.
경과를 경고하는 주석
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
요즘은 @Ignore("실행이 오래 걸린다." 속성을 이용해 테스트 케이스를 꺼버린다.
public static SimpleDateFormat makeStandardHttpDateFormat() {
	// SimpleDateFormat은 스레드에 안전하지 못하다.
	// 따라서 각 인스턴스를 독립적으로 생성해야 한다.
	SimpleDateFormat df = new SimpleDateFormat("");
	df.setTimeZone(TimeZone.getTimeZone("GMT"));
	return df;
}
더 나은 해결책이 있다고 불평할지도 모르겠지만 여기서는 주석이 아주 합리적이다.
프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면한다.
TODO 주석
TODO 주석은 프로그래머에게 필요한 주석이다.
당장 구현하기 어려운 업무를 기술한다.
중요성을 강조하는 주석
중요성을 강조하고 싶을 때 사용한다.
공개 API에서 Javadoc
표준 자바 라이브러리에서 사용한 Javadoc이 좋은 예다.
나쁜 주석
대다수 주석이 이 범주에 해당한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 않는다.
주절거리는 주석
이해가 되지 않는 주석을 이해하기 위해 답을 알아내려면 다른 코드를 뒤져보는 수밖에 없다
같은 이야기를 중복하는 주석
헤더에 달린 주석을 중복한다면 읽는 시간이 더 오래 걸린다.
오해할 여지가 있는 주석
주석에 담긴 '살짝 잘못된 정보'로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.
의무적으로 다는 주석
모든 함수에 Javadocs를 담거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
이력을 기록하는 주석
과거에는 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다. 지금은 완전히 제거하는 편이 좋다.
있으나 마나 한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
무서운 잡음
때로는 Javadocs도 잡음이다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (semodule.getDependSubsystems().contains(subSysMod.getSubSystem())
// 위 주석을 없애고 코드로 표현하면
ArrayList moduleDependees = smodule.getDependSubsystem();
String outSubSystem = subSysMod.getSubSystem();
if(moduleDependees.contains(ourSubSystem))
위치를 표시하는 주석
소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
// Actions ///////////////////////////////////////////
닫는 괄호에 다는 주석
중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 (우리가 선호하는) 작고 캡슐화된 함수에는 잡음일 뿐이다.
공로를 돌리거나 저자를 표시하는 주석
소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요가 없다.
// 릭이 추가함
주석으로 처리한 코드
주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
이유가 있어 남겨놓으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.
1960년대에는 주석으로 처리한 코드가 유용했었으나 현재는 소스 코드 관리 시스템을 사용해왔기에 잃어버릴 염려는 없다.
HTML 주석
소스 코드에서 HTML 주석은 혐오 그자체다.
전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
/** 
	* 적합성 테스트가 동작하는 포트: 기본값은 8082.
	*
	* @param fitnessePort
	*/
public void setFitnessePort(int fitnessePort) {
	this.fitnessePort = fitnessProt;
}
함수 자체가 포트 기본값(8082)을 전혀 통제할 수 없다. 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없다.
너무 많은 정보
주석에다 흥비로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
/** 
	* 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
	* 그리고 헤더 정보를 위해 200바이트를 더한다.
	*/
this.pngBytes = new byte[**this.width + 1) * this.height * 3) + 200];
필터 바이트란 무엇인가??? +1과 관련이 있는건지 *3과 관련이 있는건지 알 수 없다.
200을 추가하는 이유는 무엇인지 설명이 부족하다.
함수 헤더
짧은 함수는 긴 설명이 필요 없다.
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
예제
4-7 예제는 책 참고

클린 코드 - 4장

댓글