함수는 작을 수록 좋다.
if/else 문, while 문 등에 들어가는 블록은 한줄이어야 한다.
함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.
이렇게 복잡함을 줄이면 함수를 읽고 이해하기 쉬워진다.
함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행하도록 만들어야 한다.
한 함수 안에서 여러 섹션으로 나눠진다면 여러 작업을 한다는 것이다.
함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
한 함수 안에서 추상화 수준을 섞으면 읽는 사람이 헷갈린다.
위에서 아래로 이야기처럼 읽혀야 한다.
결과적으로 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계식 낮아지게 된다.
switch, if/else 문은 작게 만들기 어렵고, 한 가지 작업만 하게 만드는 것도 어렵다.
사용해야 한다면 가능한 한 다른 코드에 노출되지 않게 숨겨보자.
함수가 작고 단순할수록 서술적인 이름을 고르기 쉽다.
길고 서술적인 이름이 짧고 어려운 이름, 길고 서술적인 주석보다 좋다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용하자.
일관성 있게 이름을 붙이면 코드를 순차적으로 풀어가기 쉬워진다.
함수에서 이상적인 인수 개수는 0개고, 다음은 1개, 그 다음은 2개이며, 3개는 가능한 한 피하는 것이 좋고, 4개 이상은 사용하지 않는 것이 좋다.
인수는 개념을 이해하기 어렵게 만든다.
출력 인수는 입력 인수보다 이해하기 어렵다.
- 인수에 질문을 던지는 경우
- fileExists("MyFile")
- 인수를 뭔가로 변환해 결과를 반환하는 경우
- intTostr(MyNum)
- 이벤트 함수
- 이벤트라는 사실이 코드에 명확히 드러나야 한다.
이 외의 경우는 단항 함수는 가급적 피한다.
플래그 인수는 쓰지 않는 것이 좋다.
플래그 인수를 쓴다는 것은 그 함수가 여러가지 일을 한다는 것을 말한다.
이항 함수는 단항 함수보다 이해하기 어렵다.
두 인수는 자연적인 순서가 있으면 사용할만 하다.
이항 함수가 무조건 나쁜 것은 아니지만, 단항 함수보다 위험이 따르므로 가능하면 단항 함수로 바꾸는 것이 좋다.
삼항 함수는 이항 함수보다 이해하기 어려워 위험도 늘어나므로 만들 때는 신중히 고려한다.
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
x,y를 Point로 줄이면 이항이 단항이 된다.
때로는 인수 개수가 가변적인 함수도 필요하다.
가변 인수 전부를 List 형 인수 하나로 취급할 수 있다면 인수의 수를 줄일 수 있다.
// java의 String.format 메소드
String.format("%s worked %.2f hours.", name, hours);
// name과 hours를 List 형 인수 하나로 취급
public String format(String format, Object... args)단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
writeField(name)
함수 이름에 키워드(인수 이름)를 추가하면 인수 순서를 기억할 필요가 없어진다.
asserExpectedEqualsActual(expected, actual)
부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 다른 짓을 하는 것이기 때문에 예상치 못한 일이 발생할 수 있다.
함수는 한 가지 일만 수행하는 것을 기억하자.
일반적으로 출력 인수는 피해야 한다.
함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
명령과 조회를 분리해 혼란을 주지 않게 만든다.
# attribute 값을 value로 설정하고 성공하면 true, 실패하면 false를 반환한다.
def set_(attribute, value):
try:
attribute = value
return True
except:
return False
# username이 unclebob으로 설정되어 있는지 확인하는 것인지, username을 unclebob으로 설정하는 것인지 불분명하여 혼란을 준다.
if set_("username", "unclebob"):try/except와 같은 예외 처리를 하면 오류 처리 코드가 원래 코드에서 분리되어 코드가 깔끔해진다.
try/except 블록은 원래 코드 구조에 혼란을 일으키며, 정상 동작과 오류처리 동작을 뒤섞는다.
그래서 try/except 블록을 별도 함수로 뽑아내는 편이 좋다.
오류 처리도 '한 가지' 작업이므로 오류를 처리하는 함수는 오류만 처리해야 한다.
중복은 소프트웨어에서 모든 악의 근원이므로 제거하려고 노력해야 한다.
데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 했다.
즉, 함수는 return 문이 하나여야 하고, 루프 안에서 break나 continue를 사용하면 안되고, goto는 절대로 안된다.
하지만 위 규칙은 함수가 아주 클 때만 상당한 이익을 제공하고, 작으면 별 이익을 제공하지 못한다. 그러므로 함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다. 오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워 진다.
처음에는 길고 복잡하며, 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길고, 이름은 즉흥적이고 코드는 중복된다. 하지만 이 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만들고, 코드를 다듬고, 함수를 만들고, 이름을 바꾸고 중복을 제거한다.
처음부터 깨끗한 함수는 없고, 그것을 다듬어 나가는 것이 필요하다.
경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.
주석은 코드로 의도를 표현하지 못하는 실패를 만회하기 위해 주석을 사용한다. 주석을 언제나 실패를 의미한다.
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 ㅁ낳이 달린 코드보다 훨씬 좋다.
몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
# 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if (employee.flags & HOURLY_FLAG) and (employee.age > 65):if (employee.isEligibleForFullBenefits())어떤 주석은 필요하거나 유익하다. 하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이다.
각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보 등이 있다.
# Copyright (C) 2003, 2004, 2005 by Object Mentor, Inc. All rights reserved.
# GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.기본적인 정보를 주석으로 제공하는 경우이다.
# kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\d*:\\d*\\d* \\w*, \\w* \\d*, \\d*")이 경우에도 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 주석이 필요없어진다.
구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명하는 경우이다.
// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i > 2500; i++) {
WidgetBuilderThread widgetBuilderThread =
new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
Thread thread = new Thread(widgetBuilderThread);
thread.start();
}인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
assertTrue(a.compareTo(a) == 0;) // a == a
assertTrue(a.compareTo(b) != 0); // a != b그릇된 주석을 달아놓을 위험이 상당히 높고, 주석이 올바른지 검증도 어렵다.
그러므로 위와 같은 주석을 달 때는 더 나은 방법을 생각해보고, 정확히 달도록 주의해야 한다.
다른 프로그래머에게 결과를 경고할 목적으로 사용한다.
# 여유 시간이 충분하지 않다면 실행하지 마십시오
for i in range(0, 100000000000):
j = i ** 2'앞으로 할 일'을 #TODO 주석으로 남겨두면 편하다.
# TODO a를 반환하도록 변경해야 한다.
def tempFunction():
a = 10
return NoneTODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청 등에 유용하다.
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
dateNotstripped = ' 2022-02 '
datestripped = dateNotstripped.strip()
# 여기서 strip은 정말 중요하다. strip 함수는 문자열 좌우 공백을 제거한다.
# 문자열 시작에 공백이 있으면 추후 사용시 의도하지 않은 결과가 나올 수 있기 때문이다.대다수의 주석이 이 범주에 속한다.
일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
특별한 이유 없이 다는 주석이다.
public void loadProperties() {
try {
String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
FileInputStream propertiesStream = new FileInputStream(propertiesPath);
loadedProperties.load(propertiesStream);
} catch (IOException e) {
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
}
}주석이 다른 사람들에게 전해지지 않아 답을 알아내려면 다른 코드를 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석으로 제대로 된 주석이 아니다.
코드 내용을 그대로 중복하는 주석이다.
// this.closed가 true일 때 반환되는 유틸리티 메서드다.
// 타임아웃에 도달하면 예외를 던진다.
public synchronized void waitForClose(final long timeoutMillis) throws Exception {
if (!closed) {
wait(timeoutMillis);
if (!closed) {
throw new Exception("MockResponseSender could not be closed");
}
}
}위 코드는 오해할 여지도 있는 주석이었다. this.closed가 true로 변하는 순간에는 메소드는 반환되지 않는다. this.closed가 true여야 메소드는 반환된다. 아니면 무조건 타임아웃을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다.
주석에 담긴 '살짝 잘못된 정보'로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 경솔하게 함수를 호출해서 코드가 느려진 이유를 찾는데 시간을 쓰게되는 것이다.
모든 함수에 docstring을 달거나 모든 변수에 주석을 달아야 한다는 규칙에 맞춰 다는 주석은 코드를 복잡하게 만들고, 헷갈리고, 거짓말할 가능성을 높인다.
모듈을 편집할 때마다 모듈에 변경을 기록하는 주석을 말하는 데 이는 소스 코드 관리가 편해진 지금 할 필요가 없는 작업이다.
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석을 말한다.
print(a) # a를 출력한다.주석이 필요하지 않도록 코드를 개선하는 것이 최우선 사항이다.
소스 파일에서 특정 위치를 표시하려고 사용한 주석이다.
# 지역변수 ////////////////////////////////////이런 주석은 가독성만 낮추므로 제거하는 것이 좋고, 특히 /로 이어지는 부분은 제거하는 것이 좋다.
너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기하므로, 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하는 것이 바람직하다.
a = [[1,2,3],
[1,2,3],
[1,2,3]] # a 끝# KrTeaparty 추가함이런 정보는 소스 코드 관리 시스템에 저장하는 것이 좋다.
주석으로 처리된 코드는 다른 사람들이 지우기를 주저하게 되고, 코드 관리 시스템이 기억해주기 때문에 필요가 없다.
b = c
# a = b
# b = c주석을 달아야 한다면 근처에 있는 코드만 기술한다. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하는 것은 좋지 않다.
# PORT 값은 0000
a = PORT주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 않는다.
'''
PORT 번호가 1111이었는데 2222로 바뀌었다가 이번에 0000으로 바뀌었다.
'''주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
# 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
# 그리고 헤더 정보를 위해 200바이트를 더한다.
pngBytes = byte[((width + 1) * height * 3) + 200]여기서 필터 바이트가 무엇인지 알 수가 없는 것처럼 주석이 다시 설명을 요구해선 안된다.
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.