<div id="readability-page-1" class="page"><article id="post-1820">
			
		<div>
			
<h3 id="주석으로-담아야-될-대상">주석으로 담아야 될 대상</h3>



<p>주석은 코드를 읽는 사람이 작성한 사람만큼의 이해도를 갖출 수 있게 도와주는 역할</p>



<p>코드를 작성할 때의 의도를 기록하자. 코드에서 해결되지 않은 결함, 어떤 상수가 결정된 이유 같은 것들.</p>



<p>타인이 물어볼 만한 질문의 답 적기, 코드를 사용할 때의 유의점 적기</p>



<p>주석도 결국 글이다. 처음부터 완벽하지 않아도 됨. 점점 다듬어 나가면 좋은 주석이 됨.</p>



<h3 id="명확하고-간결한-주석">명확하고 간결한 주석</h3>



<ul><li>엉터리 문장 다듬기</li><li>코드의 의도 명시하기</li><li>함수 파라미터에 적어두는 주석</li></ul>



<h2 id="루프와-논리를-단순화하기">루프와 논리를 단순화하기</h2>



<h3 id="읽기-쉽게-흐름-제어-만들기">읽기 쉽게 흐름 제어 만들기</h3>



<ul><li>조건문에서 인수의 순서를 생각하기</li><li>요다 표기법 쓰지 않기 ex) <code>if (NULL == obj)</code></li><li>if/else 블록의 순서<ul><li>긍정을 선호하자</li><li>간단한 블록을 먼저 쓰자</li><li>더 주의를 기울여야 하는 것을 먼저 다루어라</li></ul></li><li>중첩 최소화하기</li></ul>



<h3 id="거대한-표현을-잘게-쪼개기">거대한 표현을 잘게 쪼개기</h3>



<ul><li>복잡한 값, 동작을 변수, 함수, 매크로 등으로 묶어주자</li><li>재사용성도 가독성도 좋아진다</li></ul>



<h3 id="변수와-가독성">변수와 가독성</h3>



<ul><li>임시 변수 제거하기</li><li>변수의 범위를 좁혀라</li><li>변수의 선언을 사용 직전에 해라</li><li>값을 한 번만 할당하는 변수를 선호해라</li></ul>



<h2 id="코드-재작성하기">코드 재작성하기</h2>



<h3 id="상관-없는-하위문제-추출하기">상관 없는 하위문제 추출하기</h3>



<ol><li>상위 수준에서 본 이 코드의 목적은 무엇인가</li><li>이 코드는 목적과 직접적으로 상관없는 하위 문제를 해결하고 있는가?</li><li>2번에 해당하는 코드가 길면, 별도의 함수로 추출하라</li><li>지나치게 추출하는 것도 좋지는 않다</li></ol>



<h3 id="한-번에-하나씩">한 번에 하나씩</h3>



<p>코드가 수행하는 모든 ‘작업’을 나열한다</p>



<p>이러한 작업을 분리하여 서로 다른 함수로 만들어라, 아니면 적어도 논리적으로 구분이 가능하게 수정해라</p>



<h3 id="생각을-코드로-만들기">생각을 코드로 만들기</h3>



<p>코드를 더 명확하게 만드는 과정</p>



<ol><li>코드가 할 일을 동료에게 말하듯 자연어로 묘사하기</li><li>이 설명에 들어가는 핵심적인 단어 포착</li><li>설명과 부합하는 코드 작성</li></ol>



<h3 id="코드-분량-줄이기">코드 분량 줄이기</h3>



<ul><li>요구 사항을 잘 분석하면 최대한 구체적인 문제를 정의할 수 있어서 코드 분량을 줄일 수 있다.</li><li>코드베이스를 작게 유지하기</li><li>라이브러리와 친숙해져라</li></ul>



<h3 id="테스트와-가독성">테스트와 가독성</h3>



<ul><li>가독성, 유지보수 하기 좋은 테스트를 만들어라</li><li>하나의 테스트 케이스를 추가하는데 필요한 코드가 짧은 것이 이상적이다.</li><li>의미 있는 assert 메세지 만들기</li><li>테스트 입력값도 의미가 있어야 한다. 큰<br> 음수를 정의할거면 integer.neg_inf 같은걸 쓰지 -1000 같은 이상한 수 쓰지 말기</li><li>테스트 함수에 이름은 자세하게</li><li>지나친 테스트는 실제 코드의 가독성과 개발 비용에 영향을 줌.</li><li>테스트가 프로젝트에서 얼마나 중요한지 생각해보기(우주선 장비 개발이면 지나쳐도 당연함)</li></ul>
			
			
								</div>
</article></div>

Wraithkim의 지식공방

주석으로 담아야 될 대상 주석은 코드를 읽는 사람이 작성한 사람만큼의 이해도를 갖출 수 있게 도와주는 역할 코드를 작성할 때의 의도를 기록하자. 코드에서 해결되지 않은 결함, 어떤 상수가 결정된 이유 같은 것들. 타인이 물어볼 만한 질문의 답 적기, 코드를 사용할 때의 유의점 적기 주석도 결국 글이다. 처음부터 완벽하지 않아도 됨. 점점 다듬어 나가면 좋은 주석이 됨. […]

읽기 좋은 코드가 좋은 코드가 – 2

댓글