맛있는 페이지 준비중...맛있는 페이지 준비중...
이번 글에서는 좋은 주석 쓰는 방법과, 형식 맞추기 방법 들에 대해서 소개할게요.
잘 달진 주석은 그 어떤 정보보다 유용해요. 하지만 근거 없는 주석은 코드를 이해하기 어렵게 만들어요. 그리고 오래 관리가 안된 주석은 잘못된 정보를 전달하기도 해요.
저자는 주석은 필요악이라 표현해요. 코드 자체에 표현력과 전달력이 있다면 주석은 거의 필요하지 않기 때문이에요. 즉, 나쁜 코드에 주석을 달은 경우라고 볼 수 있어요. 그래서 주석을 달기전에 먼저 코드로 의도를 표현할 방법이 없을지 생각해보는 것이 좋아요. 주석을 달면 본인이 표현력이 부족함을 인정하는 것과 마찬가지에요.
그러면 왜이렇게 주석을 미워할까요? 바로 주석이 거짓말하는 경우가 많아서에요. 고의적으로 거짓말하는 것은 아니지만, 주석이 오래될수록 코드에서 멀어지기 때문이에요. 또한 개발자가 주석을 유지 및 보수하는 것도 현실적으로 불가능하다고 여겨져요. 아마도 주석을 달아봤으면 알거에요. 언제 썼는지 기억이 안나요.
코드는 변화하고 진화해요. 여기 저기 옮겨다니기도 해요. 그리고 분열했다가 합쳐지기도 합니다. 그래서 주석이 코드를 따라가기 힘들어요.
코드에 주석을 추가하는 가장 일반적인 이유는 코드 품질이 나쁘기 때문이에요. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기가 힘들어 주석을 달아야겠다는 결심을 하죠. 이럴 땐 "주석을 달아야겠다!"가 아니라 "코드를 정리해야겠다!"라고 말할 수 있어야해요.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 좋아요
확실히 코드만으로 의도를 설명하기 어려운 경우가 있어요. 하지만 많은 개발자가 이를 코드는 훌륭한 수단이 아니라고 잘못 생각해요. 다음 예제로 알아봐요.
1번 예제// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.if((employee.flags & HOURLY_FLAG) && (employee.age > 5))2번 예제if(employee.isEligibleForFullBenefits())두 예제를 보면 어떤가요? 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있음을 알 수 있어요. 주석으로 달려는 설명을 함수로 만들어 표현하면 좋아요.
정말 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이에요. 여기서는 유익하거나 필요한 주석을 소개하려고해요.
법적인 주석
회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣을 수 있어요. 대표적인 예로 소스 파일 첫머리에 들어가는 저작권 정보와 소유권 정보에요.
// Copyright (C) 2023,2024,2025 by Object Mentor, Inc. All rights reserved.// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하기도해요. 예를 들어 다음과 같은 주석이에요.
// 테스트 중인 Responder 인스턴스를 반환한다.protected abstract Responder responderInstance();=> 개선, responderBeingTested로 이름 바꾸면 주석이 필요 없어짐.물론 위 주석도 좋지만 다음과 같은 예시가 더 좋은 예시에요.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.Pattern timeMatcher = Pattern.compie( "\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명해요. 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔해요. 그러면 주석이 필요없어지니까요.
의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 것을 넘어 결정에 깔린 의도까지 설명해요. 다음 예제로 봐요.
public int compareTo(Object o) { if(o instanceof WikiPagePath) { WikiPagePath p = (WikiPagePath) o; String compressedName = StringUtil.join(names, ""); String compressedArgumentName = StringUtil.join(p.name, ""); String CompressedName.compareTo(compressedArgumentName); } return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다.}다음 예제가 더 좋은 예제에요. 저자가 문제를 해결한 방식에 동의하지 않더라도 저자의 의도가 명확히 드러나요.
public void testConcurrentAddWidgets() throws Exception { WidgetBuilder widgetBuilder = new WidgetBuilder(new Class[](BoldWidget.class)); String text = "'''bold text'''"; ParentWidget parent = new BoldWidget(new MockWidgetRoot(), "'''bold text'''"); AtomicBoolean failFlag = new AtomicBoolean(); failFlag.set(false); // 어떻게든 경쟁 조건을 만들기 위해 스레드를 대량 생성하는 방법을 사용. for (int i = 0; i < 25000; i++) { WidgetBuilderThread widgetBuilderThread = new WidgetBuilderThread(widgetBuilder, text, parent, failFlag); Thread thread = new Thread(widgetBuilderThread); thread.start(); } assertEquals(false, failFlag.get());}의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 좋아요. 물론 인수나 반환값 자체를 명확하게 만들면 좋지만, 현실은 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속해서 변경하지 못하는 경우가 있어요. 그래서 의미를 명료하게 밝히는 주석이 유용하게되요.
public void testCompareTo() throws Exception{ WikiPagePath a = PathParser.parse("PageA"); WikiPagePath ab = PathParser.parse("PageA.PageB"); WikiPagePath b = PathParser.parse("PageB"); WikiPagePath aa = PathParser.parse("PageA.PageA"); WikiPagePath bb = PathParser.parse("PageB.PageB"); WikiPagePath ba = PathParser.parse("PageB.PageB"); 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 < a 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}위 코드는 잘못된 주석을 적을 확률이 높아요. 그리고 옳바른지 검증하기도 힘들고요. 이것이 의미를 명확히하는 주석이 필요한 이유인 동시에 주석이 위험한 이유에요.
결과를 경고하는 주석
때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용해요. 예를 들면 다음의 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석이에요.
// 여유 시간이 없으면 실행하지 마세요.public void _testWithReallyBigFile(){ writeLineToFile(10000000); response.setBody(testFile); response.readyToSend(this); String responseString = output.toString(); assertSubString("Content-Length: 1000000000", respnseString); assertTrue(bytesSent > 1000000000);}이번에는 다른 적절한 주석을 보여줄게요.
public static SimpleDateFormat makeStandardHttpDateFormat(){ // SimpleDateFormat은 스레드에 안전하지 않습니다. // 따라서 각 인스턴스를 독립적으로 생성해야 합니다. SimpleDateFormat df = new SimpleDateformat("EEE, dd MMM yyyy HH:mm:ss z"); df.setTimeZone(TimeZone.getTimeZone("GMT")); return df;}더 나은 해결책이 있다고 말하는 사람도 있을거에요. 그럼에도 이 주석은 합리적이에요. 효율을 위해 정적 초기화 함수를 사용하려던 프로그래머가 주석 때문에 실수를 피할 수 있어요.
TODO 주석
때로는 "앞으로 할 일"을 TODO 주석으로 남겨두면 편해요. 다음은 함수를 구현하지 않은 이유와 미래 모습을 TODO 주석으로 설명한 예제에요.
// TODO-MdM 현재 필요하지 않다.// 체크아웃 모델을 도입하면 함수가 필요 없다.protected VersionInfo makeVersion() throws Exception { return null}TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술해요. 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용해요. 하지만 어떤 요도로 사용해도, 나쁜 코드를 남겨놓는 핑계가 되면 안돼요.
자주사용되는 TODO 같은 주석 태그에 대해서 정리해봤어요.
TODO : 당장은 어렵지만 나중에 추가로 작업해야 하는 부분 표현
FIXME : 즉시 수정이 필요한 또는수정이 필요하다고 논의한 코드를 표현
HACK : 임시적인 해결책(문제 회피 기법)에 대한 주석
XXX : 다른 프로그래머에게 나중에 검토하거나 개선할 필요가 있는 부분(비효율적인 코드) 표현
중요성을 강조하는 주석
대수롭지 않다고 여겨질 것의 중요성을 강조하기 위해 사용해도 좋아요.
String listItemContent = match.group(3).trim();// 여기서 trim은 매우 중요. trim 함수는 문자열에서 시작 공백 제거.// 문자열 시작 공백이 있으면 다른 문자열로 인식하기 때문new ListItemWidget(this, listItemContent, this.level + 1);return buildList(text.substring(match.end()));공개 API에서 Javadocs
설명이 잘 된 공개 API는 만족스러워요. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예에요. 공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성해야해요. 다른 주석과 마찬가지로 그릇된 정보를 전달하지 않도록 해야해요.
대다수 주석이 나쁜 주석에 속해요. 허술한 코드를 보조하거나, 변명하거나, 합리화하는 등 프로그래머가 주절거리는 독백에 지나지않아요.
주절거리는 주석
이유 없이 의무감에 혹은 프로세스 아래에 주석을 달면 시간 낭비에요. 주석을 달기로 결정했다면, 시간을 들여 최고의 주석을 달도록 노력해야해요. 다음 예시는 그냥 주절거려 판독이 불가능한 주석이에요.
public void loadProperties() { try { String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE; FileInputStream propertiesStream = new FileInputStream(propertiesPath); loadedProperties.load(propertiesStream); } catch(IOException e) { // 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다 }}catch 블록에 있는 주석 의미가 전혀 전해지지 않아요. IOException이 발생하면 속성 파일이 없다는 뜻인거 같아요. 그런데 기본값은 또 뭔지 아무것도 모르겠어요. 답을 알아내려면 다른 코드를 뒤져보는 수밖에 없겠네요.
같은 이야기를 중복하는 주석
아래 예시는 주석이 코드의 내용을 그대로 적었어요. 자칫하면 코드보다 주석 읽는 시간이 더 걸리겠네요.
// 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"); } } }}위 코드의 문제는 코드가 부정확해 의미를 모두 전달하지 못하기 때문에 주석을 썼을 확률이 높아요. 주석을 보고 대충 넘어가주길 바라는 느낌이에요.
또 다른 예시로 Tomcat에서 가져온 코드에요. 쓸모없는 중복된 Javadocs가 너무 많아요.
public abstract class ContainerBase implements Container, Lifecycle, Pipeline, MBeanRegistration, Serializable { /** * 이 컴포넌트의 프로세서 지연값 */ protected int backgroundProcessorDelay = -1; /** * 이 컴포넌트를 지원하기 위한 생명주기 이벤트 */ protected LifecycleSupport lifecycle = new LifecycleSupport(this); /** * 이 컴포넌트를 위한 컨테이너 이벤트 리스너 */ protected ArrayList listeners = new ArrayList(); /** * 컨테이너와 관련된 loader 구현 */ protected Loader loader = null; /** * 컨테이너와 관련된 Logger 구현 */ protected Log logger = null; /** * 관련 logger 이름 */ protected String logName = null; /** * 컨테이너와 관련된 Manager 구현 */ protected Manager manager = null; /** * 컨테이너와 관련된 Cluster */ protected Cluster cluster = null; /** * 사람이 읽을 수 있는 컨테이너 이름 */ protected String name = null; /** * 컨테이너의 부모 컨테이너 */ protected Container parent = null; /** * Loader를 설치할 때 구성이 끝나야 할 어버이 클래스 로더 */ protected ClassLoader parentClassLoader = null; /** * 컨테이너와 관련된 Pipeline 객체 */ protected Pipeline pipeline = new StandardPipeline(this); /** * 컨테이너와 관련된 Realm */ protected Realm realm = null; /** * 컨테이너와 관련된 DirContect 객체 */ protected DirContext resources = null;근데 저같은 초보에게는 위 주석 일부는 오히려 이해하기 편하게 만들어 주는 것 같아요.
오해할 여지가 있는 주석
아까 위 코드에서 this.closed가 true이면 반환된다는 유틸리티 함수가 기억나나요? 그런데 함수를 보면 아무것도 반환되지 않고 있어요. 주석에 담긴 "잘못된 정보"로 반환될거라 생각했던 true가 반환되지 않고 있어요. 그래서 다른 프로그래머가 골치아픈 경우가 생길 수 있어요.
의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 주석을 다는 규칙은 어리석어요. 오히려 주석이 코드를 복잡하게 만들고, 거짓말과 혼동을 초래해요. 그리고 주석 관리까지 해야하니 더 비용이 많이 들어가요. 굳이 주석이 없어도 이해되지 않나여?
/** * * @param title CD 제목 * @param author CD 저자 * @param tracks CD 트랙 숫자 * @param durationInMinutes CD 길이(단위:분) */public void addCD(String title, String author, int tracks, int durationInMinutes) { CD cd = new CD(); cd.title = title; cd.author = author; cd.tracks = tracks; cd.duration = duration; cdList.add(cd);}사견: 위와 같은 일이 일어나는 이유는 왜일까..? 구성원들이 코드를 예상치 못하게 짜서 타입과 이름을 신뢰하지 못해서 일까? 아니면 코드짜는 사람이 CD 객체를 직접 받도록 했어야 했을까? 생각이 많아진다.
이력을 기록하는 주석
종종 모듈을 편집할 때 첫머리에 변경 이력을 남겨요. 예전에는 변경 이력을 남기는 것이 관례이고 필요했지만, 소스 코드 버전 관리 시스템을 사용하면서 필요 없어졌으니 제거하는 편이 좋아요.
있으나 마나 한 주석
때때로 있으나 마나 한 주석을 접해요. 너무 당연한 사실을 언급하여 새로운 정보를 주지 못하는 주석이에요.
// 기본 생성자protected AnnualDateRule() {}// 월 중 일자private int dayOfMonth;위와 같은 주석이 많아지면 너무 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠질 수 있어요. 그리고 이는 코드가 바뀌면서 주석이 거짓이 되어 버려요.
무서운 잡음
때로는 Javadocs도 잡음이에요. 다음은 잘 알려진 오픈 소스 라이브러리에서 가져온 코드에요.
/** The name. */private String name;/** The version. */private String version;/** The licenceName. */private String licenceName;/** The Info */private String info;거의 붙여넣기한 거 같아요. 독자가 여기서 무슨 이익을 얻을 수 있어 보이나요?
함수나 변수로 표현할 수 있다면 주석을 달지 마라
// 전역 목록<smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?if(smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))<--- 개선 후 --->ArrayList moduleDependees = smodule.getDependSubsystems();String ourSubSystem = subSysMod.getSubSystem();if(moduleDependees.contains(ourSubSystem))위 코드를 보면 코드를 알아보기 힘들어서 주석을 넣었지만, 코드를 개선하면 굳이 주석이 필요 없어요. 물론 저자가 주석을 먼저 달고 주석에 맞춰 코드를 작성했을 수도 있어요. 하지만 위와 같은 주석이 필요하지 않도록 개선하는게 좋아요.
위치를 표시하는 주석
위치를 표시하려고 "// Actions ///////////" 이런식으로 주석을 다는 경우가 있어요. 해당 주석 배너 아래에 Action들을 모아놨을 거 같아요. 뒤에 ////같은 거는 너무 눈에 띄고 별루라고 독자가 말해요. 그리고 저런 배너는 반드시 필요할 때만 드물게 사용하는게 좋다고 말해요. 저 또한 저런 배너를 유명한 라이브러리에서 쓰는 걸 본적이 있어요.
닫는 괄호에 다는 주석
중첩이 심하고 장황한 함수라면 닫는 괄호가 의미가 있을 수 있지만, 작고 캡슐화된 함수를 선호하는 우리들에게는 그럴 확률이 적어요. 닫는 괄호에 주석을 달아야겠다는 생각이 들면 함수를 줄이도록 시도해봐요. 다음 코드가 그 예시에요
public class wc { public static void main(String[] args) { BufferedReader in = new BufferedReader(new InputStreamReader(System.in)); String line; int lineCount = 0; int charCount = 0; int wordCount = 0; try { while((line = in.readLine()) != null) { lineCount++; ... } // while System.out.println("wordCount = " + wordCount); System.out.println("charCount= " + charCount); System.out.println("lineCount = " + lineCount); } // try catch (IOException e) { System.err.println("에러:" + e.getMessage()); } // catch } // main}공로를 돌리거나 저자를 표시하는 주석
"/* 당근이 추가함 */"과 같은 주석은 더이상 필요 없어요. 버전 관리 시스템을 통해 누가 언제 무엇을 추가했는지 알 수 있으니까요.
주석으로 처리한 코드
주석으로 처리한 코드도 버전 관리 시스템이 생기면서 굳이 남겨둘 필요가 없어요. 독자에게 정보를 전달하기 힘들거든요. 근데 저는 사실 코드 이력 보겠다고 버전 돌리는 것도 힘들긴 해요. ㅜㅜ
HTML 주석
이거는 진짜 주석에서 <p/>, <pre/>, " 같은거로 주석 다는 거에요. 저자가 엄청 혐오하는 거에요. 저도 이건 혐오스러워요. 굳이 예시도 안보여줄게요. 정말 필요한 경우가 있을 수도 있을거 같긴해요. 예를들면 JS Docs에서 컴포넌트 사용법을 적어줄 때요. 그럴 때는 분명 사용할 수 있겠죠?
/** * Headless Select component using Render Props * * @example * ```jsx * <HeadlessSelect * options={['Apple', 'Banana', 'Orange']} * value={value} * onChange={setValue} * > * {({ value, open, toggle, select }) => ( * <div> * <button onClick={toggle}> * {value ?? 'Select a fruit'} * </button> * {open && ( * <ul> * {['Apple', 'Banana', 'Orange'].map((opt) => ( * <li key={opt} onClick={() => select(opt)}> * {opt} * </li> * ))} * </ul> * )} * </div> * )} * </HeadlessSelect> * ``` */전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하는게 좋아요. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하면, 해당 정보가 변해도 추적도 힘들고 통제도 불가해요.
/** * 적합성 테스트가 동작하는 포트: 8082 * @param fitnessePort */public void setFitnessePort(int fitnessePort) { this.fitnessePort = fitnessePort;}너무 많은 정보
주석에 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마세요. 다음 예시를 보면 RFC 번호를 제외하면 독자에게 불필요한 정보일 뿐이에요.
/* RFC 2045 - Multipurpose Internet Mail Extensions (MIME) 1부: 인터넷 메시지 본체 형식 6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding) 인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된 출력 문자열로 표현한다. 왼쪽에서 오른쪽으로 진행해가며, 3개를 묶어 8비트 입력...*/모호한 관계
주석과 코드 사이 관계가 명백해야해요. 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽고 무슨 소리인지는 알아야겠죠?
/* * 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다). * 그리고 헤더 정보를 위해 200바이트를 더한다. */this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];위 코드에서 필터 바이트가 뭐라고 생각하나요? +1인가요? *3인가요? 200바이트는 왜 더할까요? 주석 자체가 다시 설명을 요구하게되요.
함수 헤더
짧은 함수는 긴 설명이 필요 없어요. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 더 좋아요.
비공개 코드에서 Javadocs
공개 API는 Javadocs가 유용해요. 하지만 공개하지 않을 코드라면 Javadocs가 쓸모가 없어요. 오히려 Javadocs 주석이 요구하는 형식으로 인해 코드만 산만해져요.
예제
아래 코드는 켄트 벡이 학생들 앞에서 멋진 형태로 리팩토링하는데 사용한 코드에요.
/** * 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은 * 에라토스테네스의 체다. * <p> * 에라토스테네스: 기원전 276년에 리비아 키레네에서 출생 ... * 설명 ... * <p> * 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로 * 2의 배수를 모두 제거한다. 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다. * 최대 값의 제곱근이 될 때까지 이를 반복한다. * * @author Alphonse * @version 13 Feb 2002 atp * */public class GeneratePrimes { /** * @param maxValue는 소수를 찾아낼 최대 값 * @return int[] */ 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=i*2; 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]; // 입력이 잘못되어 비어 있는 배열을 반환한다. } }}그리고 다음 코드가 리팩터링한 결과에요. 주석이 상당히 줄어든 것을 볼 수 있을 거에요. 주석이 2개밖에 없네요.
/** * 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다. * 알고리즘은 에라토스테네스의 체다. * 2에서 시작하는 정수 배열을 대상으로 작업한다. * 처음으로 남아 있는 정수를 찾아 배수를 모두 제거한다. * 배열에 더 이상 배수가 없을 때까지 반복한다. */public class PrimeGenerator { private static boolean[] crossedOut; private static int[] result; public static int[] generatePrimes(int maxValue) { if(maxValue < 2) { return new int[0]; } else { uncrossIntegersUpTo(maxValue); crossOutMultiples(); putUncrossedIntegersIntoResult(); return result; } } private static void uncrossIntegersUpTo(int maxValue) { crossedOut = new boolean[maxValue + 1]; for(int i=2; i<crossedOut.length; i++) { crossedOut[i] = false; } } private static void crossOutMultiples() { int limit = determineIterationLimit(); for(int i=2; i<=limit; i++) { if(notCrossed(i)) { crossOutMultiplesOf(i); } } } private static int determineIterationLimit() { // 배열에 있는 모든 배수는 배열 크기의 제곱근보다 작은 소수의 인수다. // 따라서 이 제곱근보다 더 큰 숫자의 배수는 제거할 필요가 없다. double iterationLimit = Math.sqrt(crossedOut.length); return (int)iterationLimit; } private static void crossOutMultiplesOf(int i) { for(int multiple = i*2; multiple<crossedOut.length; multiple += i) { crossedOut[multiple] = true; } } private static boolean notCrossed(int i) { return crossedOut[i] == false; } private static void putUncrossedIntegersIntoResult() { result = new int[numberOfUncrossedIntegers()]; for(int j=0, i=2; i<crossedOut.length; i++) { if(notCrossed(i)) { result[j++] = i; } } } private static int numberOfUncrossedIntegers() { int count = 0; for(int i=2; i<crossedOut.length; i++) { if(notCrossed(i)) { count ++; } } return count; }}위 코드 리팩터링에 대해서 저자는 다음과 같이 말해요.
첫 번째 주석이 generatePrimes 함수 자체와 흡사하기 때문에 중복이라고 주장할 수 있다. 하지만 주석이 있어 알고리즘 이해하기 쉬워진다고 생각하여 남겼다.
두 번째 주석은 확실히 필요하다. 루프 한계값으로 제곱근을 사용한 이유를 설명한다. 나로서는 변수 이름을 바꾸거나 코드 구조를 조정해 이유를 명확하게 설명할 방법을 찾지 못했다. 또 다른 한편으로 제곱근의 사용은 나만의 생각일지도 모르겠다. 제곱근까지만 루프를 돌면 정말로 시간을 절약할까? 제곱근 계산에 오히려 시간이 더 들지 않을까?
4장에 대해 간략하게 소개했는데 도움이 많이 되셨나요? 저는 한장 한장 볼때마다 저의 생각과 주장이 떠올라요. 이번 장은 대체로 다 동의해요. 그런데 최근에 저는 AI로 코딩을 클린하고 효율적으로 하기위해 공부하고 적용해보고 있어요. 그런지 위 주장들 중에 공개 API가 아니라면 Javadocs를 안적는 것이 좋을지 생각해보게 되네요. 사람이 코딩을 하면 같은 팀원들이 서로 만든 api를 사용한다면, 내부 API라도 Javadocs가 도움이 될거 같다고 생각해요. 그런데 그 효용성에 대해서는 들인 노력만큼 시간적 가치가 있을까 생각하면 글쎄.. 더 생각해봐야할 거 같아요.(물론 AI로 Javadocs 뚝딱 만드니까 패러다임이 바뀔까요??) 그리고 AI가 코딩을 하면 Javadocs가 코딩하는데 더 도움을 줄까?라는 생각을 하면서 아까운 내 토큰을 왕창 갉아먹을 것 같은 생각도 하게 되네요. 물론 또 다른 관점에서는 결국 전체 코드 디자인은 내가 하는 것이니 AI가 Javadocs를 알든 모르든 크게 영향이 없을 것 같기도 해요. 아무튼 그런 생각을 했답니다.
뚜껑을 열었을 때 독자들이 코드가 깔끔, 일관, 꼼꼼하다고 감탄하고, 질서 정연하다고 탄복하면 좋겠죠? 그리고 모듈을 읽으며 두 눈이 휘둥그래 놀라고 전문가가 짰다는 인상을 심어주면 좋을거에요. 반대로 술 취한 사람이 코드를 짠거처럼 어수선해 보이면 독자들은 프로젝트의 다른 측면들도 무성의한 태도로 처리했다고 생각할거에요.
우리는 프로그래머(전문가!)이기 때문에 형식을 깔끔하게 맞춰 코드를 짜야해요. 그래서 코드 형식을 맞추기위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야해요.
코드 형식은 중요해요! '돌아가는 '코드'가 개발자의 일차적인 의무라 여길 수 도 있지만, 저자는 의사소통이 전문 개발자의 일차적인 의무라 생각해요. 그리고 의사소통의 일환으로 코드 형식이 있어요. 코드는 계속 바뀌더라도 개발자의 스타일과 규율은 사라지지 않고 가독성에 영향을 줄 뿐만아니라, 유지 보수성과 확장성까지 영향을 줘요.
적절한 행 길이는 몇줄이 적달할까요? 저자가 옛날에 조사해보니 다음과 같았다고 해요.
유명한 프로젝트들의 파일들의 라인 수 분포를 뽑은 그림이에요. 얇은 세로선은 최소와 최대 라인 수를 나타내고, 두꺼운 세로 선(상자)는 표준편차, 상자 가운데는 평균을 나타내요.
위의 표가 말해주는 사실은 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이에요. 반드시 지킬 엄격한 규칙은 아니지만 200줄 정도를 바람직한 규칙으로 삼으면 좋아요. 특히 요즘 시대에 모니터 화면이 큼직하고, IDE도 좋아서 200줄이 많은 줄일 수도 있다는 생각도 들어요.
이제 본격적으로 세로 형식을 맞추는 방법들에 대해서 하나씩 소개할게요.
신문 기사처럼 작성하라
좋은 신문 기사는 위에서 아래로 전체적인 내용이 나오며 점점 세세한 사실들이 드러나요. 소스 파일도 신문 기사와 비슷하게 작성하면 좋아요. 모듈의 상단을 보면 무슨 내용이 나올지 예측이되어 내가 찾는 모듈인지 판단할 수 있어야 하고, 아래로 내려갈수록 의도를 세세하게 묘사해야해요. 그리고 마지막에는 가장 저차원 함수와 세부 내역이 나오고요.
개념은 빈 행으로 분리하라
거의 모든 코드는 좌에서 우로, 위에서 아래로 읽어요. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 하나의 생각을 표현해요. 그리고 생각 사이는 빈 행을 넣어 분리해야 해요.
package fitnesse.wikitext.widgets;import java.util.regex.*;public class BoldWidget extends ParentWidget { public static final String REGEXP = "'''.+?'''"; private static final Pattern pattern = Pattern.compile("'''(.+?)'''", Pattern.MULTILINE + Pattern.DOTALL ); public BoldWidget(ParentWidget parent, String text) throws Exception { super(parent); Matcher match = pattern.matcher(text); match.find(); addChildWidgets(match.group(1)); } public String render() throws Exception { StringBuffer html = new StringBuffer("<b>"); html.append(childHtml()).append("</b>"); return html.toString(); } }위 코드를 보면 패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어가요. 간단한 규칙이지만 세로 레이아웃에 많은 영향을 줘요. 빈 행은 새로운 개념을 시작한다는 시각적 단서에요. 그리고 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈추죠. 만약 위 코드를 빈 행 없이 붙여 보세요. 암호문 처럼 보일거에요.
세로 밀집도
줄바꿈이 개념을 부리한다면 세로 밀집도는 연관성을 의미해요. 서로 밀접한 코드는 세로로 가까이 놓아야 한다는 것을 말해요.
public class ReporterConfig { /** * The class name of the reporter listener */ private String m_className; /** * The properties of the reporter listener */ private List<Property> m_properties = new ArrayList<Property>(); public void addProperty(Property property) { m_properties.add(property); }}위 코드와 아래 코드를 비교해봐요. 위 코드는 의미 없는 주석으로 코드 행을 떨어뜨렸고 아래행은 주석이 없어요. 아마 아래 코드가 더 쉬울거에요. 머리나 눈을 움직일 필요도 없고, 변수 2개와 메서드 1개라는 사실이 바로 보여요.
public class ReporterConfig { private String m_className; private List<Property> m_properties = new ArrayList<Property>(); public void addProperty(Property property) { m_properties.add(property); }}수직 거리
함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지고 뺑뺑이를 돌았으나 미로 같은 코드 때문에 혼란만 가중된 경험이 있나요? (저요저요 React 19 파악하려하는데 너무 미로같았어요.) 결코 달갑지 않은 경험이에요. 시스템을 이해하고 싶어도 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 다 써요.
서로 밀접한 개념은 세로로 가까이 둬야해요. 물론 두 개념이 서로 다른 파일에 속하면 규칙이 통하지 않아요. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 있는게 좋아요. 이게 protected 변수를 피해야하는 이유 중 하나에요(자바의 접근 제어자 protected는 자식 클래스에서 접근하니까 코드 파악 어지러워짐! 인정? ㅇ 인정).
즉, 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현해요. 여기서 "연관성"이란 "한 개념을 이해하는 데 다른 개념이 중요한 정도"에요
수직 거리 예시
변수와 함수는 사용되는 위치에 최대한 가깝게 정의
지역 변수는 처음 사용하기 직전에 선언
비공개 함수는 처음 호출한 직후에 정의 (조금만 내려가면 보이게), 가능하면 호출하는 함수를 먼저 배치하자.
인스턴스 변수는 맨 처음에(C++에서는 보통 마지막에) 선언한다.(잘 알려진 위치에 모으는게 중요)
상수는 저차원 함수에 묻히지 마라(상수는 고차원 함수에 두고, 저차원 함수에는 인수로 넘겨라)
개념적 유사성이 높은 코드는 가까이 배치한다. (A코드가 B코드를 쓰면 서로 종속되기 때문에 친화도가 높다.)
세로 순서
일반적으로 함수 호출 종속성은 아래 방향으로 유지해요. 즉, 호출되는 함수가 호출하는 함수보다 나중에 배치되요(C, C++은 먼저 정의하는 경우 많음). 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려가요. 마치 신문 기사에서 중요한 개념을 가장 먼저 표현하고 세세한 내용을 마지막에 표현하듯이요.
한 행은 가로로 얼마나 길어야 적당할까요? 앞에서와 같이 분석해봐요.
위 그림은 7개 유명 프로젝트의 자바 라인의 가로 길이 분포도에요.결과가 상당히 규칙적이에요. 20-60자 사이인 행이 총 행수의 40%정도 되요. 10자 미만은 30%정도로 보이고요. 증 60자 이하가 70%가까이 차지하네요. 80자 이후는 10%정도가 되고요. 요즘은 모니터도 크고 해서 좀더 많아도 될것 같아요. 저자는 100자~120자 정도까지 제한 두는게 괜찮을 것 같다고 말해요.
이제 가로 형식 맞추는 방법들에 대해서 소개할게요.
가로 공백과 밀집도
가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현해요.
private void measureLine(String line) { lineCount++; int lineSize = line.length(); totalChars += lineSize; lineWidthHistogram.addLine(lineSize, lineCount); recordWidestLine(lineSize);}위 함수를 보면 할당 연산자를 강조하려고 앞뒤에 공백을 줬어요. 할당 연산자는 왼쪽 요소와 오른쪽 요소가 확실히 나뉘어요. 그래서 공백을 넣으면 더 분명해져요. 반면에 함수 이름과 이어지는 괄호 사이에는 공백이 없어요. 왜냐하면 공백을 넣으면 별개로 보이기 때문이에요. 그리고 인수 사이의 쉼표 다음에는 공백을 줘서 인수가 별개라는 사실을 강조해요. (요즘은 lint, prettier같은 걸로 자동으로 다된다. 규칙 설정만 잘 하면 된다.)
public class Quadratic { public static double root1(double a, double b, double c) { double determinant = determinant(a, b, c); return (-b + Math.sqrt(determinant)) / (2*a); } public static double root2(int a, int b, int c) { double determinant = determinant(a, b, c); return (-b - Math.sqrt(determinant)) / (2*a); } private static double determinant(double a, double b, double c) { return b*b - 4*a*c; }}위 코드를 보면 수식 읽기가 편해요. 승수 사이는 공백이 없어요. 곱셈은 우선순위가 가장 높기 때문이에요. 하지만 항 사이에는 공백이 들어가요. 덧셈과 뺄셈은 곱셈보다 우선순위가 낮기 때문이에요.
가로정렬
저자는 어셈블리어 시절 특정 구조를 강조하고자 가로 정렬을 사용했데요. 다음과 같이 말이죠
public class FitNesseExpediter implements ResponseSender{ private Socket socket; private InputStream input; private OutputStream output; private Request request; private Response response; private FitNesseContext context; protected long requestParsingTimeLimit; private long requestProgress; private long requestParsingDeadline; private boolean hasError; public FitNesseExpediter(Socket s, FitNesseContext context) throws Exception { this.context = context; socket = s; input = s.getInputStream(); output = s.getOutputStream(); requestParsingTimeLimit = 10000; }그런데 위와 같은 정렬이 별로 좋지 않다는 것을 깨달았데요. 엉뚱한 부분을 강조해서 진짜 의도가 가려져요. 예를 들면, 위 선언부를 읽다 보면 변수 유형은 무시하고 변수 이름부터 읽게 되요. 그리고 할당 연산자는 눈에가지 않고 오른쪽 피연산자만 눈에 가요. 무엇보다 대부분 코드 정렬 도구는 위와 같은 공백을 무시해요. 코드를 정렬하면 오히려 중대한 결함을 찾기 힘들어져요.
만약 정렬이 필요할 정도로 길다면 문제는 목록의 길이지 정렬 부족이 아니에요. 코드 선언부가 길다면 클래스를 쪼개야 한다는 의미에요.
들여쓰기
들여쓰기를 하지 않으면 코드를 읽기 힘들어져요. 이건 굳이 설명 안해도 알 것 같아서 넘어갈게요. if문 여러개인데 모두 한줄에 있다고 생각해봐요. 얼마나 끔찍해요. 저자는 가끔 1줄로도 가능한 짧은 코드는 들여쓰기 안쓰는 유혹에 빠진다고 해요. 그치만 결국 원점으로 돌아가 들여쓰기를 한다고 해요.
프로그래머로서 각자 선호하는 규칙이 있어요. 하지만 자신이 선호해야 할 규칙은 팀 규칙이에요. 어처피 대부분 정한 규칙은 IDE코드 형식기로 설정한 후 사용하기도 해서 어렵지 않아요. 그리고 저자도 팀 규칙이 마음에 안들어도 팀 규칙에 따라 코드를 구현했다고 해요.
아래 코드는 밥 아저씨의 형식을 잘 나타내는 표준 문서 수준이라고 자신하는 코드에요.
public class CodeAnalyzer implements JavaFileAnalysis { private int lineCount; private int maxLineWidth; private int widestLineNumber; private LineWidthHistogram lineWidthHistogram; private int totalChars; public CodeAnalyzer() { lineWidthHistogram = new LineWidthHistogram(); } public static List<File> findJavaFiles(File parentDirectory) { List<File> files = new ArrayList<File>(); findJavaFiles(parentDirectory, files); return files; } private static void findJavaFiles(File parentDirectory, List<File> files) { for (File file : parentDirectory.listFiles()) { if (file.getName().endsWith(".java")) files.add(file); else if (file.isDirectory()) findJavaFiles(file, files); } } public void analyzeFile(File javaFile) throws Exception { BufferedReader br = new BufferedReader(new FileReader(javaFile)); String line; while ((line = br.readLine()) != null) measureLine(line); } private void measureLine(String line) { lineCount++; int lineSize = line.length(); totalChars += lineSize; lineWidthHistogram.addLine(lineSize, lineCount); recordWidestLine(lineSize); } private void recordWidestLine(int lineSize) { if (lineSize > maxLineWidth) { maxLineWidth = lineSize; widestLineNumber = lineCount; } } public int getLineCount() { return lineCount; } public int getMaxLineWidth() { return maxLineWidth; } public int getWidestLineNumber() { return widestLineNumber; } public LineWidthHistogram getLineWidthHistogram() { return lineWidthHistogram; } public double getMeanLineWidth() { return (double)totalChars/lineCount; } public int getMedianLineWidth() { Integer[] sortedWidths = getSortedWidths(); int cumulativeLineCount = 0; for (int width : sortedWidths) { cumulativeLineCount += lineCountForWidth(width); if (cumulativeLineCount > lineCount/2) return width; } throw new Error("Cannot get here"); } private int lineCountForWidth(int width) { return lineWidthHistogram.getLinesforWidth(width).size(); } private Integer[] getSortedWidths() { Set<Integer> widths = lineWidthHistogram.getWidths(); Integer[] sortedWidths = (widths.toArray(new Integer[0])); Arrays.sort(sortedWidths); return sortedWidths; } }5장에서는 코드 형식들에 대해서 이야기해봤어요. 그런데 5장의 형식들은 대부분 Linter나 Prettier같은 도구를 통해서 충분히 해결할 수 있어서 엄청 마음에 와닿지는 않았어요. 그래도 당연한 것들도 한번 더 체크해보고, 과거에는 어떤지 알 수 있어서 좋았어요. 우리 모두 클린 코드를 위해 앞으로 계속 노력해가요.