[4장] 주석
- 잘 달린 주석은 그 어느 정보보다 유용하다!
- 주석은 사실 기껏해야 필요악이지만... 실패를 만회하기 위해 우리는 주석을 사용한다...!
- 코드는 변화하고 진화하지만, 주석이 언제나 코드를 따라가지는 못한다. 주석이 코드에서 분리되어 점점 더 부정확한 고아로 변하는 사례가 너무도 흔하다...
MockRequest request;
private final String HTTP_DATE_REGEXP =
"[SMTWF][a-z]{2}\\,\\s[0-9]]{2}\\s[JFMASOND][a-z]{2}\\s"+
"[0-9]{4}\\s[0-9]{2}\\:[0-9]{2}\\:[0-9]{2}\\sGMT";
private Response response;
private FitNesseContext context;
private FileResponder responder;
private Locale saveLocale;
// Example: "Tue, 02 Apr 2003 22:18:49 GMT"- 짐작컨대, HTTP_DATE_REGEXP 상수와 주석 사이에 다른 인스턴스 변수를 추가했을 가능성이 농후하다
- 주석을 엄격하게 관리해야 한다고 하지만,,, 그냥 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다는 작가,,,
- 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 결코 이뤄지지 않을 기대를 심어준다.
- 진실은 한 곳에만, 코드만이 자기가 하는 일을 진실되게 말한다.
- 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
주석은 나쁜 코드를 보완하지 못한다
- 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다...
- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
코드로 의도를 표현하라!
- 확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 그리고 많은 개발자들은 이를 코드는 훌륭한 수단이 아니라는 의미로 해석하기도 한다.
# 1
# 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if (employee.flags and HOURLY_FLAG) and (employee.age > 65)
# 2
if employee.isEligibleForFullBenefits()- 위의 예시에서 볼 수 있듯이, 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
- 의도가 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
좋은 주석
- 어떤 주석은 필요하거나 유익하다. 하지만 정말 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을! (<- 뭔소리야)
법적인 주석
- 때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
- 아래 코드는 FitNess에서 모든 소스 파일 첫머리에 추가한 표준 주석 헤더다.
# Copyright (C) 2003,2004,2005 by Obejct Mentor, Inc. All rights reserved.
# GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.- 소스 파일 첫머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없다.
- 모든 조항과 조건을 열거하는 대신에, 가능하다면, 표준 라이선스나 외부 문서를 참조해도 되겠다.
정보를 제공하는 주석
- 때로는 기본적인 정보를 주석으로 제공하면 편리하다.
- 아래 주석은 추상 메서드가 반환할 값을 설명한다.
# 테스트 중인 Responder 인스턴스를 반환한다.
def responderInstance() -> Responder:- 위와 같은 주석이 유용하다 할지라도, 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.
- 위 코드 함수의 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.
# kk:mm:ss EEE, MMM dd, yyyy 형식이다.
timeMatcher = Pattern.compile("\\d*:\\d*:\\d& \\w*, \\w* \\d*, \\d*")- 위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
- 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면... 주석이 필요 없어지겠지!
의도를 설명하는 주석
- 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
- 아래 코드에서 두 객체를 비교할 때 저자는 다른 어떤 객체보다 자기 객체에 높은 순위를 주기로 결정했다...!
def compareTo(o:Object)->int:
if isinstance(o, WikiPagePath):
p = (WikiPagePath)o
compressedName = StringUtil.join(names, "")
compressedArgumentName = StringUtil.join(p.names, "")
return compressedName.compareTo(compressedArgumentName)
return 1 # 옳은 유형이므로 정렬 순위가 더 높다.- 다음은 더 나은 예제다.
def testConcurrentAddWidgets():
widgetBuilder = WidgetBuilder(BoldWidget.class)
text = "'''bold text'''"
parent = BoldWidget(MockWidgetRoot(), "'''bold text'''")
failFlag = AtomicBoolean()
failFlag.set(False)
# 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for i in range(25000):
widgetBuilderThread = WidgetBuilderThread(widgetBuilder, text, parent, failFlag)
thread = Thread(widgetBuilderThread)
thread.start()
assertEquals(False, failFlag.get())의미를 명료하게 밝히는 주석
- 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
- 일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
def testCompareTo():
a = PathParser.parse("PageA")
ab = PathParser.parse("PageA.PageB")
b = PathParser.parse("PageB")
aa = PathParser.parse("PageA.PageA")
bb = PathParser.parse("PageB.PageB")
ba = PathParser.parse("PageB.PageA")
assertTrue(a.compareTo(a) == 0) # a == a
assertTrue(a.compareTo(b) != 0) # a != b
assertTrue(ab.compareTo(ab) == 0) # ab == ab
assertTrue(a.compareTo(b) == -1) # a < b
assertTrue(aa.compareTo(ab) == -1) # aa < ab
assertTrue(ba.compareTo(bb) == -1) # ba < bb
assertTrue(b.compareTo(a) == 1) # b > a
assertTrue(ab.compareTo(aa) == 1) # ab > aa
assertTrue(bb.compareTo(ba) == 1) # bb > ba- 물론 그릇된 주석을 달아놓을 위험은 상당히 높다.
- 위와 같은 예시에서 주석이 올바른지 검증하기 쉽지 않기 때문에 의미를 명료히 밝히는 주석이 필요한 동시에 주석이 위험한 이유이기도 하다.
- 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의해야 한다
결과를 경고하는 주석
- 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
- 아래 코드는 특정 테스트 케이스를 꺼야 하는 이유를 설명하는 주석이다.
# 여유 시간이 충분하지 않다면 실행하지 마십시오.
def _testWithReallyBigFile():
writeLinesToFile(100000000)
response.setBody(testFile)
response.readyToSend(this)
responseString = str(output)
assertSubString("Content-Length: 10000000", responseString)
assertTrue(bytesSent > 10000000)- 요즘 자바에서는 @Ignore("실행이 너무 오래 걸린다.")를 이용하여 테스트케이스를 꺼주는 기능이 있음.
- 하지만 JUnit4가 나오기 전에는 메서드 이름 앞에 _ 기호를 붙이는 방법이 일반적인 관례였음
- 아래는 주석이 아주 적절한 예제
def makeStandardHttpDateFormat()->SimpleDateFormat:
# SimpleDateFormat은 스레드에 안전하지 못하다.
# 따라서 각 인스턴스를 독립적으로 생성해야 한다.
df = SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z")
df.setTimeZone(TimeZone.getTimeZone("GMT"))
return df- 프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면할 수 있다.
TODO 주석
- '앞으로 할 일'을 # TODO 주석으로 남겨두면 편하다.
- 아래는 함수를 구현하지 않은 이유와 미래 모습을 #TODO 주석으로 설명한 예제
# TODO-MdM 현재 필요하지 않다.
# 체크아웃 모델을 도입하면 함수가 필요 없다.
def makeVersion()->VersionInfo:
return NULL- TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술.
- 요즘 나오는 대다수 IDE는 TODO 주석 전부를 찾아 보여주는 기능을 제공하지만, TODO로 떡칠한 코드는 바람직하지 않다.
- 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애길 바람.
중요성을 강조하는 주석
- 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용
listItemContent = match.group(3).strip()
# 여기서 strip은 정말 중요하다. strip 함수는 문자열에서 시작 공백을 제거한다.
# 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
ListItemWidget(self, listItemContent, self.level+1)
return buildList(text.substring(match.end()))공개 API에서 Javadocs
- 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다...
- 공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성하도록 해라... 하지만 이 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.
나쁜 주석
- 대다수 주석이 이 범주에 속함
- 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 벗어나지 못함
주절거리는 주석
- 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.
- 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
- 아래 코드는 그냥 주석으로 주절거려 놓았기에 판독이 불가능하다.
def loadProperties():
try:
propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE
propertiesStream = FileInputStream(propertiesPath)
loadedProperties.load(propertiesStream)
except (IOException e):
# 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.- 위 주석의 답을 알아내려면 다른 코드를 뒤져보는 수밖에 없다...
- 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이고, 그런 주석은 바이트만 낭비할 뿐
같은 이야기를 중복하는 주석
- 아래 코드는 간단한 함수를 보여주고 있으며, 헤더에 달린 주석이 같은 코드 내용을 그대로 중복하고 있기 때문에 코드보다 주석을 읽는 시간이 더 오래 걸릴 수 있다.
# self.closed가 True일 때 반환되는 유틸리티 메서드다.
# 타임아웃에 도달하면 예외를 던진다.
def waitForClose(timeoutMillis:int):
if not closed:
wait(timeoutMillis)
if not closed:
Exception("MockResponseSender could not be closed")- 위에선 주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.
- 아래 코드에는 쓸모없고 중복된 Javadocs가 매우 많다. 코드만 지저분하고 정신 없게 만든다. (적으면서 정말 잘 깨달았다)
class ContainerBase:
'''
이 컴포넌트의 프로세서 자연값
'''
backgroundProcessorDelay = -1
'''
이 컴포넌트를 지원하기 위한 생명주기 이벤트
'''
lifecycle = LifeCycleSupport(self)
'''
이 컴포넌트를 위한 컨테이너 이벤트 Listener
'''
listeners = ArrayList()
'''
컨테이너와 관련된 Loader 구현
'''
loader = NULL
'''
컨테이너와 관련된 Logger 구현
'''
logger = NULL
'''
관련된 logger 이름
'''
logName = NULL
'''
컨테이너와 관련된 Manager 구현
'''
manager = NULL
'''
컨테이너와 관련된 Cluster
'''
cluster = NULL
'''
사람이 읽을 수 있는 컨테이너 이름
'''
name = NULL
'''
컨테이너의 부모 컨테이너
'''
parent = NULL
'''
Loader를 설치할 때 구성이 끝나야 할 어버이 클래스 로더
'''
parentClassLoader = NULL
'''
컨테이너와 관련된 Pipeline 객체
'''
pipeline = StandardPipeline(self)
'''
컨테이너와 관련된 Realm
'''
realm = NULL
'''
컨테이너와 관련된 DirContect 객체
'''
resources = NULL오해할 여지가 있는 주석
- 때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.
- 코드보다도 읽기 어려운 주석에 담긴 살짝 잘못된 정보로 인해 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.
의무적으로 다는 주석
- 모든 함수에 Javadocs를 달거나 모든 변수에 다는 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
- 아래와 같은 주석은 아무 가치도 없이 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지만 만든다.
"""
@param title CD 제목
@param author CD 저자
@param tracks CD 트랙 숫자
@param durationInMinutes CD 길이(단위: 분)
"""
def addCD(title:str, author:str, tracks:int, durationInMinutes:int):
cd = CD()
cd.title = title
cd.author - author
cd.tracks = tracks
cd.duration = durationInMinutes
cdList.add(cd)이력을 기록하는 주석
- 때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가하여 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된 것을 확인할 수 있다.
# 변경 이력 (11-Oct-2001부터)
# ----------------------------
# 11-Oct-2001 : 클래스를 다시 정의하고 새로운 패키지인
# com.jrefinery.date로 옮겼다 (DG)
# 05-Nov-2001 : getDescription() 메서드를 추가했으며
# NotableDate class를 제거했다 (DG)
# 12-Nov-2001 : IBD가 setDescription() 메서드를 요구한다.
# NotableDate 클래스를 없앴다 (DG)
# getPreviousDayOfWeek(), getFollowingDayOfWeek(),
# getNearestDayOfWeek()를 변경해 버그를 수정했다 (DG)
# 05-Dec-2001 : SpreadsheetDate클래스에 존재하는 버그를 수정했다 (DG)
# 29-May-2002 : month 상수를 독자적인 인터페이스로 옮겼다
# (MonthConstants) (DG)
# 27-Aug-2002 : addMonths() 메서드에 있는 버그를 수정했다.
# N??levka Petr 덕분이다 (DG)
# 03-Oct-2002 : Checkstyle이 보고한 오류를 수정했다 (DG)
# 13-Mar-2003 : Serializable을 구현했다 (DG)
# 29-May-2003 : addMonths 메서드에 있는 버그를 수정했다 (DG)
# 04-Sep-2003 : Comparable을 구현했다. isInRange Javadocs를 갱신했다 (DG)
# 05-Jan-2005 : addYears() 메서드에 있는 버그를 수정했다 (1096282) (DG)- 예전에는 소스 코드 관리 시스템이 없었기 때문에 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다.
- 하지만 지금은 혼란만 가중할 뿐이기 때문에... 완전히 제거하는 편이 좋다.
있으나 마나 한 주석
- 때때로 있으나 마나 한 주석을 접한다. 쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
'''
기본 생성자
'''
AnnualDateRule():
pass
'''
월 중 일자
'''
dayOfMonth = int
'''
월 중 일자를 반환한다.
@return 월 중 일자
'''
def getDayOfMonth()->int:
return dayOfMonth- 제일 마지막 코드는 전형적인 중복을 보여주기도...
- 위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠지게 되어 코드를 읽으며 자동으로 주석을 건너뛴다.
- 아래 catch 블록을 무시해도 괜찮은 이유를 설명하고 있는 첫 번째 주석은 적절해 보이나, 두 번째 주석은 전혀 쓸모가 없다.
def startSending():
try:
doSending()
except (SocketException e):
# 정상. 누군가 요청을 멈췄다.
pass
except (Exception e):
try:
response.add(ErrorResponder.makeExceptionString(e))
response.closeAll()
except (Exception e1):
# 이게 뭐야!
pass- 있으나 마나 한 주석을 적는 대신 코드 구조를 개선했더라면 짜증낼 필요가 없었을텐데...
def startSending():
try:
doSending()
except (SocketException e):
# 정상. 누군가 요청을 멈췄다.
pass
except (Exception e):
addExceptionAndCloseResponse(e)
def addExceptionAndCloseResponse(Exception e):
try:
response.add(ErrorResponder.makeExceptionString(e))
response.closeAll()
except (Exception e1):
pass- 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다.
무서운 잡음
- 때로는 Javadocs도 잡음이다.
- 아래 코드에서의 Javadocs는 아무 목적을 수행하지 않고, 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.
""" The name """
name = ""
""" The version """
version = ""
""" The licenceName """
licenceName = ""
""" The version """
info = ""- 주석을 작성한 저자가 주의를 기울이지 않았다면 독자가 여기서 무슨 이익을 얻겠는가...
함수나 변수로 표현할 수 있다면 주석을 달지 마라
# 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if smodule.getDependSubsystems().contains(subSysMod.getSubSystem()):- 위 코드에서 주석을 없애고 다시 표현한 것이 바로 아래 코드
moduleDependees = smodule.getDependSubsystems()
ourSubsystem = subSysMod.getSubSystem(0
if moduleDependees.contains(ourSubSystem):- 코드를 작성한 저자는 주석을 먼저 달고 주석에 맞춰 코드를 작성했을지도 몰라...
- 하지만 위와 같이 주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다.
위치를 표시하는 주석
- 때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
########### Actions #############- 극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 있지만... 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다. 특히 뒷부분의 # 잡음은 제거하는 편이 좋다.
- 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기시킬 수 있으므로, 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
- 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
닫는 괄호에 다는 주석
- 때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다.
- 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만, 작고 캡슐화된 함수에는 잡음일 뿐이다.
- 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
class wc:
def main(self):
self.in = BufferedReader(InputStreamReader(input()):
self.line = ""
self.lineCount = 0
self.charCount = 0
self.wordCount = 0
try:
while (line = self.in.readLine()) is not NULL:
self.lineCount += 1
self.charCount += len(self.line)
self.words = line.split("\\W")
self.wordCount += len(self.words)
# while
print("wordCount = ", self.wordCount)
print("lineCount = ", self.lineCount)
print("charCount = ", self.charCount)
# try
except (IOException e):
print("Error : ", e.getMessage())
# except
# main공로를 돌리거나 저자를 표시하는 주석
""" 릭이 추가함 """- 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억하기 때문에 굳이 저런 내용을 넣을 필요가 없다.
- 그냥 위와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
주석으로 처리한 코드
- 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다...!
response = InputStreamResponse()
response.setBody(formatter.getResultStream(), formatter.getByteCount())
# resultsStream = formatter.getResultStream()
# reader = StreamReader(resultsStream)
# response.setContent(reader.read(formatter.getByteCount()))- 주석으로 처리된 코드는 다른 사람들이 이유가 있어 남겨놓았으리라고 생각하여 지우기를 주저한다.
self.bytePos = writeBytes(pngIdBytes, 0)
# hdrPos = bytePos
self.writeHeader()
self.writeResolution()
# dataPos = bytePos
if self.writeImageData():
self.writeEnd()
self.pngBytes = self.resizeByteArray(self.pngBytes, self.maxPos)
else:
self.pngBytes = NULL
return self.pngBytes- 1960년대 즈음에는 주석으로 처리한 코드가 유용했으나, 이제는 소스 코드 관리 시스템을 사용하고 있기 때문에 그냥 지워라!
HTML 주석
- 소스 코드에서 HTML 주석은 혐오 그 자체다... 편집기/IDE에서조차 읽기가 어렵다
###
# 적합성 테스트를 수행하기 위한 과업
# 이 과업은 적합성 테스트를 수행해 결과를 출력한다.
# <p/>
# <pre>
# 용법 :
# <taskdef name="execute-fitnesse-tests"
# classname="fitnesse.ant.ExecuteFitnesseTestsTask&quuot
# classaparthref="classpath" />
# 또는
# <
# <taskdef classpathref=" classpath"
# resource=Squot; tasks.properties" />
# <p/>
# <execute-fitnesse-tests
# suitepage=" FitNesse.SuiteAcceptanceTests"
# fitnesseport="8082"
# resultsdir="${results.dir}"
# resultshtmlpage="fit-results.html"
# classpathref=Squot; classpath" />
# </pre>
###전역 정보
- 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
- 아래 코드의 주석은 바로 아래 함수가 아니라 시스템 어딘가에 있는 다른 함수를 설명하고 있다...
###
# 적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>
#
# @param fitnessPort
###
def setFitnessPort(self, fitnessPort:int):
self.fitnessPort = fitnessePort너무 많은 정보
- 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
"""
RFC 2045 - Multipurpose Internet Mail Extensions (MIME)
1부 : 인터넷 메시지 본체 형식
6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된
출력 문자열로 표현한다. 왼쪽에서 오른쪽으로 진행하가며, 3개를 묶어 8비트 입력
그룹을 형성한다. 이렇게 만들어진 24비트는 4개를 붂어 6비트 그룹으로 취급하며,
각각은 base64 알파벳에서 단일 자릿수로 해석된다.
base64 인코딩으로 비트 스트림을 인코딩할 때, 비트 스트림은
MSB(Most Significant Bit) 우선으로 정렬되어 있다고 가정한다. 따라서, 스트림에서
첫 번째 비트는 첫 8비트 바이트에서 최상위 비트가 되며, 여덟번째 비트는 첫 8비트
바이트에서 최하위 비트가 된다.
"""모호한 관계
- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
###
# 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다.)
# 그리고 헤더 정보를 위해 200바이트를 더한다.
###
self.pngBytes = byte[((self.width + 1) * self.height * 3) + 200]- 주석을 다는 목적은 코드만으로 설명이 부족해서이다. 주석 자체가 다시 설명을 요구해선 안된다.
함수 헤더
- 짧은 함수는 긴 설명이 필요 없다.
- 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
- 공개하지 않을 코드라면 Javadocs는 쓸모가 없다. 유용하지 않을 뿐만 아니라 Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.
예제
- 아래 모듈이 매력적인 이유는 우리들 상당수가 이런 코드를 보면서 '주석을 잘 달았다'고 생각했던 시절이 있었기 때문이다. 하지만 이제는 엉성한 코드로 여겨진다.
###
# 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용한 알고리즘은
# 에라토스테네스의 체다.
# <p>
# 에라토스테네스 : 기원전 276년에 리비아 키레네에서 출생, 기원전 194년에 사망
# 지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람.
# 알렉산드리아 도서관장을 역임.
# <p>
# 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로
# 2의 배수를 모두 제거한다. 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다.
# 최대 값의 제곱근이 될 때까지 이를 반복한다.
#
# @author Alphonse
# @version 13 Feb 2002 atp
###
class GeneratePrimes:
###
# @param maxValue는 소수를 찾아낼 최대 값
###
def generatePrimes(maxValue:int)->List[int]:
if maxValue >= 2: # 유일하게 유효한 경우
# 선언
s = maxValue + 1 # 배열 크기
f = [bool for _ in range(s)]
i = 0
# 배열을 참으로 초기화
for i in range(s):
f[i] = True
# 소수가 아닌 알려진 숫자를 제거
f[0], f[1] = False, False
# 체
j = 0
for i in range(2, sqrt(s)+1):
if f[i]: # i가 남아 있는 숫자라면 이 숫자의 배수를 구한다
for j in range(2*i, s, i):
f[j] = False # 배수는 소수가 아니다
# 소수 개수는?
count = 0
for i in range(s):
if f[i]:
count += 1 # 카운트 증가
primes = [int for _ in range(count)]
# 소수를 결과 배열로 이동한다.
j = 0
for i in range(s):
if f[i]: # 소수일 경우에
primes[j++] = i
return primes # 소수를 반환한다.
else: # maxValue < 2
return [0] # 입력이 잘못되면 비어 있는 배열을 반환한다.- 아래 코드는 위 코드를 리팩터링한 결과다. 주석 양이 상당히 줄었다는 사실에 주목한다.
- 전체 모듈에서 주석은 두 개 뿐. 두 주석 모두 뭔가를 설명 중.
###
# 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다.
# 알고리즘은 에라토스테네스의 체다.
# 2에서 시작하는 정수 배열을 대상으로 작업한다.
# 처음으로 남아 있는 정수를 찾아 배수를 모두 제거한다.
# 배열에 더 이상 배수가 없을 때까지 반복한다.
###
class PrimeGenerator():
def __init__(self):
self.crossedOut = []
self.result = []
def generatePrimes(self, maxValue:int)->List[int]:
if maxValue < 2:
return []
else:
self.uncrossIntegersUpTo(maxValue)
self.crossOutMultiples()
self.putUncrossedIntegersIntoResult()
return self.result
def uncrossIntegersUpTo(self, maxValue:int):
self.crossedOut = [bool for _ in range(maxValue+1)]
for i in range(2, len(crossedOut)):
self.crossedOut[i] = False
def crossOutMultiples(self):
self.limit = self.determineIterationLimit()
for i in range(2, limit+1):
if self.notCrossed(i):
self.crossOutMultiplesOf(i)
def determineIterationLimit(self)->int:
# 배열에 있는 모든 배수는 배열 크기의 제곱근보다 작은 소수의 인수다
# 따라서 이 제곱근보다 더 큰 숫자의 배수는 제거할 필요가 없다.
self.iterationLimit = sqrt(len(self.crossedOut))
return int(self.iterationLimit)
def crossOutMultiplesof(self, i:int):
for multiple in range(2*i, len(crossedOut), i):
self.crossedOut[multiple] = True
def notCrossed(self, i:int):
return self.crossedOut[i] == False
def putUncrossedIntegersIntoResult(self):
self.result = [int for _ in range(self.numberOfUncrossedIntoResult())]
j = 0
for i in range(2, len(self.crossedOut)):
if self.notCrossed(i):
j += 1
self.result[j] = i
def numberOfUncrossedIntegers(self)->int:
self.count = 0
for i in range(2, len(self.crossedOut)):
if self.notCrossed(i):
count += 1
return self.count- 첫 번째 주석이 중복이라고 주장할 수는 있으나, 해당 주석이 있어 알고리즘을 이해하기가 쉬워졌다.
- 두 번째 주석은 거의 확실히 필요하다. 변수 이름을 바꾸거나 코드 구조를 조정함으로써 이유를 명확하게 설명하기가 어렵다.
- 위에서의 제곱근은 작가에게 만족스러운 해법이지만... 남들이 이를 이해하려 시간과 노력을 투자할 가치가 있는지는 잘 모르겠다고 한다..