공부/노개북
[노개북] '클린 코드' Assignment #06
silver_ye
2022. 2. 25. 21:53
📌 1 주차
목, 금 | Assignment #6
- 📖 4장. 주석
- 📝 TIL
💡 TIL (Today I Learned)
2022.02.24.목 ~ 2022.02.25.금
📖 오늘 읽은 범위
4장. 주석
✔ 책에서 기억하고 싶은 내용을 써보세요.
- 잘 달린 주석은 그 어떤 정보보다 유용하다. - p.68
- 주석은 쉰들러 리스트가 아니다. 우레에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면 주석은 거의 필요하지 않으며, 우리가 코드로 의도를 표현하지 못해서 실패를 만회하기 위하여 주석을 사용하는 것이다. - p.68
- 코드는 변화하고 진화한다. 그러면서 일부가 여기로 저기로 조각 조각 옮겨진다. 불행하게도 주석이 언제나 코드를 따라가지 않기에 주석이 점점 부정확해지게 된다. - p.68
- 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 결코 이루어지지 않을 기대를 심어준다. - p.69
- 진실은 언제나 한곳에만 존재한다. 코드만이 정확한 정보를 제공하는 유일한 출처이다. - p.69
- 주석은 나쁜 코드를 보완하지 못한다 : 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. - p.69
- 코드로 의도를 표현하라! : 코드만으로 의도를 설명하기 어려운 경우도 존재하지만, 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다. 설명을 함수로 만들어 표현해도 충분하다. - p.70
- 좋은 주석 : 필요하거나 유익한 주석은 있지만 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.
- 👍법적인 주석 : 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다. 모든 조항과 조건을 열거하는 대신에, 가능하다면, 표준 라이선스나 외부 문서를 참조해도 된다. - p.70
- 👍정보를 제공하는 주석 : 기본적인 정보를 주석으로 제공하면 편리하지만 가능하다면 함수 이름에 정보를 담는 편이 더 좋다. - p.71
- 👍의도를 설명하는 주석 : 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. - p.71
- 👍의미를 명료하게 밝히는 주석 : 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다. 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다. - p.72
- 👍결과를 경고하는 주석 : 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. 프로그래머가 주석 때문에 실수를 면할 수 있다. - p.73
- 👍TODO주석 : 앞으로 해야 할 일을 //TODO 주석으로 남겨두면 편하다. TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안 된다. - p.74
- 👍중요성을 강조하는 주석 : 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다. - p.75
- 👍공개 API에서 Javadocs : 설명이 잘 된 공개 API는 유용하고 만족스럽다. 하지만 여느 주석과 같이 잘못 위치하거나, 그릇된 정보를 전달할 가능성도 존재한다. - p.75
- 나쁜 주석 : 대다수 주석이 나쁜 주석이다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다. - p.75
- 👎주절거리는 주석 : 특별한 이유없이 주절거리는 주석은 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력해야한다. 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다. - p.76
- 👎같은 이야기를 중복하는 주석 : 같은 코드 내용을 그래도 중복한 주석은 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸리게 만든다. 주석이 코드보다 더 많은 정보를 제공하지 못한다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다. - p.77
- 👎오해할 여지가 있는 주석 : 의도가 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다. 주석에 담긴 살짝 잘못된 정보로 인해 어느 프로그래머가 잘못된 이유를 찾느라 골머리를 앓을 수 있다. - p.79
- 👎의무적으로 다는 주석 : 모든 함수에 Javadoce를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석다. 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지를 만든다. - p.80
- 👎이력을 기록하는 주석 : 소스 코드 관리 시스템이 없었을 시절에는 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가했다. 하지만 이제는 혼란만 가중시키니 제거하는 편이 좋다. - p.81
- 👎있으나 마나 한 주석 : 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 개발자가 지나친 참견이라고 여겨 주석을 무시하는 습관에 빠트릴 수 있다. - p.81
- 👎함수나 변수로 표현할 수 있다면 주석을 달지 마라 : 할 수 있다면 주석이 필요하지 않도록 코드를 개선하는 편이 낮다. - p.84
- 👎위치를 표시하는 주석 : 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다. 하지만 배너는 눈에 너무 띄게 되니 반드시 필요할 때만 사용하는 것이 좋다. 남용하면 독자가 흔한 잡음으로 넘겨 무시하게 된다. - p.84
- 👎닫는 괄호에 다는 주석 : 다는 괄호에 특수한 주석을 달아놓는다는 것은 중첩이 심하고 장확한 함수라면 의미있을 지도 모르지만 작고 캡슐화된 함수에는 잡음이다. 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려고 시도하자. - p.85
- 👎공로를 돌리거나 저자를 표시하는 주석 : 주석이 있으면 다른 사람들이 코드에 관해서 누구에게 물어볼 지 아니깐 위와 유용한 주석이라고 여길지 모르나, 소스 코드 관리 시스템에 저장하는 편이 더 좋다. - p.86
- 👎주석으로 처리한 코드 : 주석으로 처리된 코드는 이유가 있거나 중요하다고 생각하여 다른 사람들이 지우기를 주저한다. 그에 따라 쓸모 없는 코드가 점차 쌓여간다. 소스 코드 관리 시스템이 우리르 대신해 코드를 기억해 줌으로 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. - p.86
- 👎HTML 주석 : HTML 주석은 편집기/IDE에서조차 읽기가 어렵다. 도구에게 맡기자. - p.87
- 👎전역 정보 : 코드 일부에 주석을 달면서 전반적인 정보를 기술하지 말고 근처에 있는 코드만 기술해야 한다. - p.88
- 👎너무 많은 정보 : 주석에 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 말아야 한다. - p.88
- 👎모호한 관계 : 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구하는건 안타까운 것이다. - p.89
- 👎함수 헤더 : 짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다. - p.89
- 👎비공개 코드에서 Javadocs : 공개 API는 Javadocs가 유용하지만, 공개하지 않을 코드라면 쓸모없다. Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해진다. - p.90
<잘못된 코드>
더보기
더보기
/**
* 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은
* 에라스토테네스의 체다.
* <p>
* 에라스토테네스: 기원전 276년에 리비아 키레네에서 출생, 기원전 194년에 사망
* 지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람.
* 알렉산드리아 도서관장을 역임.
* <p>
* 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로
* 2의 배수를 모두 제거한다. 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다.
* 최대 값의 제곱근이 될 때까지 이를 반복한다. *
* @author Alphonse
* @version 13 Feb 2002 atp */
import java.util.*;
public class GeneratePrimes
{
/**
* @param maxValue는 소수를 찾아낼 최대 값
*/
public static int[] generatePrimes(int maxValue)
{
if (maxValue >= 2) // 유일하게 유효한 경우
{
// 선언
int s = maxValue + 1; // 배열 크기
boolean[] f = new boolean[s]; int i;
// 배열을 참으로 초기화
for (i = 0; i < s; i++)
f[i] = true;
// 소수가 아닌 알려진 숫자를 제거 f[0] = f[1] = false;
// 체
int j;
for (i = 2; i < Math.sqrt(s) + 1; i++)
{
if (f[i]) // i가 남아 있는 숫자라면 이 숫자의 배수를 구한다.
{
for (j = 2 * i; j < s; j += i)
f[j] = false; // 배수는 소수가 아니다.
}
}
// 소수 개수는?
int count = 0;
for (i = 0; i < s; i++)
{
if (f[i])
count++; // 카운트 증가
}
int[] primes = new int[count];
// 소수를 결과 배열로 이동한다.
for (i = 0, j = 0; i < s; i++)
{
if (f[i]) // 소수일 경우에
primes[j++] = i;
}
return primes; // 소수를 반환한다.
}
else // maxValue < 2
return new int[0]; // 입력이 잘못되면 비어 있는 배열을 반환한다.
}
}📝 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
- 회사에서 코드를 읽으며, 각 자의 코드 스타일이 다 다른데 어떻게 이걸 다 하나 하나보면서 이해할 수 있을까라는 생각이 들면서 힘겹게 코드를 읽어나갔다. 그래서 잘못된 코드와 같이 친절하게 모든걸 적는 주석을 진행했었다. 다른 사람들이 나의 코드를 읽으면서 이해하기 쉽도록 열심히 달았다. 나의 과도한 친절이 나쁜 주석이 되는 지름길이었다니...😱😱😱😱😱
- 모두가 한번쯤은 잘못된 코드의 길을 접한 경험이 있을거라고 생각한다. 좋은 주석 vs 나쁜 주석 을 생각하며 주석을 달아야겠다. 물론 주석을 안달고 함수의 이름에서 알 수 있게 하는 것이 제일 좋은 방법이다👍
🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
- Javadocs
문서로 된 주석으로 코드에 대한 메소드와 클래스 내용을 적어놓은 것이다.
/** 소스 내용 설명 */