주석
- 이번 포스트의 내용을 정리하면 다음과 같습니다.
- 잘 달린 주석은 그 어떤 정보보다 유용하다.
- 주석이 필요한 상황에 처하면 곰곰이 생각해보자.
→ 상황을 역전해 코드로 의도를 표현할 방법은 없을까?- 주석은 오래될수록 코드에서 멀어진다. (평생 유지 보수는 현실적으로 불가능)
- 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
- 복구성 없는 주석 (헛갈리게 만드는 주석)
- 관련성 없는 주석 (잘못 위치한 주석)
- 정확성 없는 주석 (잘못된 정보를 적어둔 주석)
주석이 없는 것이 가장 최선!
꼭 적어야 한다면 맥락과 기능을 이해하기 쉽게 작성해두는 것이 좋다고 생각합니다.
주석은 나쁜 코드를 보완하지 못한다.
- 난장판을 주석으로 설명하려 하지말고 난장판을 깨끗이 치우는 데 시간을 보내라!
코드로 의도를 표현하라
- 주석으로 달려는 설명을 함수로 만들어 표현해도 충분
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags && HOURLY_FLAG) && (employee.age > 65))if (employee.isEligibleForFullBenefits ())좋은 주석
개인적인 생각은 좋은 주석 보다는 유효(용)한 주석이 아닌가 싶습니다.
- 정말로 좋은 주석 = 주석을 달지 않을 방법을 찾아낸 주석!
-
법적인 주석
-
회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라 명시하는 경우
// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved. // GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다. // 모든 조항, 조건을 열거하는 대신 표준 라이선스나 외부 문서를 참조해도 됨
-
-
정보를 제공하는 주석
-
기본적인 정보를 주석으로 제공하면 편리
// 테스트 중인 Responder 인스턴스를 반환한다. protected abstract Responder responderinstance(); // 위 함수의 이름을 responderBeingTested(); 로 바꾸면 주석이 필요 없어진다.// hh:mm:ss AM/PM, MM dd, yyyy 형식이다. // 11:52:59 AM, May 18, 2021 Pattern timeMatcher = Pattern.compile( "\\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. names, ""); return compressedName.compareTo(compressedArgumentName); } return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다. }public void testConcurrentAddWidgets() throws Exception { Widget Builder 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); // 스레드를 통한 widget 생성으로 어떻게든 경쟁 조건을 만들려 시도한다. 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 b = PathParser.parse("PageB"); WikiPagePath aa = PathParser.parse("PageA.PageA"); WikiPagePath bb = PathParser.parse("PageB.PageB"); WikiPagePath 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 } - 일반적으로 인수나 반환값 자체를 명확하게 하도록 수정할 수 있다면 좋겠지만...
-
결과를 경고하는 주석
// 여유 시간이 충분하지 않다연 실횅하지 마십시오. public void _testWithReallyBigFile() { writeLinesToFile(10000000); response.setBody(testFile); response.readyToSend(this); String responsestring = output.toString(); assertSubString("Content-Length: 1000000000", responsestring); assertTrue(bytesSent > 1000000000);- 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.
- 구체적인 설명은 속성에 문자열로 넣어준다
@Ignore("실행이 너무 오래 걸린다.")
- JUnit4 이전에는 메서드 이름 앞에
_기호를 붙이는 방법이 일반적인 관례
public static SimpleDateFormat makeStandardHttpDateFormat() { // SimpleDateFormat은 스레드에 안전하지 못하다. // 따라서 각 인스턴스에 독립적으로 생성해야 한다. SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy") df.setTimeZone (TimeZone.getTimeZone ("GMT")); return df; }- 더 나은 해결책이 있을지도 모르지만 여기서는 주석이 합리적이다. (주석을 보고 실수를 면하게 된다.)
- 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.
-
TODO 주석
- 앞으로 할 일을
//TODO주석으로 남겨두면 편하다. - 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술
- 더 이상 필요 없는 기능을 삭제하라는 알림
- 누군가에게 문제를 봐달라는 요청
- 더 좋은 이름을 떠올려달라는 부탁
- 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유효
- 단, 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어선 안된다.
- TODO로 떡칠한 코드는 바람직 하지 않다. 주기적으로 없애도 괜찮은 주석은 없애버리는 것이 좋음.
// TOOO-IMM 현재 필요하지 않다. // 세크아웃 모델을 도입하면 함수가 필요 없다. protected Versioninfo makeVersion() throws Exception { return null; } - 앞으로 할 일을
-
중요성을 강조하는 주석
- 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위한 목적으로도 사용
String listItemContent = match.group(3).trim(); // 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다. // 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다. new ListItemWidget(this, listItemContent, this.level + 1); return buildList(text.substring(match.end())); -
공개 API에서의 Javadocs
- 설명이 잘 된 공개 API는 유용하고 만족스럽다.
- 공개 API를 구현한다면 사용자를 위해 반드시 훌륭한 javadocs를 작성한다.
- 물론 javadocs 또한 읽는 사람을 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.
나쁜 주석
- 대다수의 주석이 이 범주에 속한다.
- 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등
-
주절거리는 주석
- 특별한 이유 없이 의무감, 또는 프로세스에서 하라 하여 마지못해 주석을 단다면 전적으로 시간낭비다!
- 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
public void loadProperties() { try { String properties Path = propertiesLocation + "/" + PROPERTIES_FILE; FileInputStream propertiesStream = new FileInputStream(propertiesPath); loadedProperties.load(propertiesStream); } catch(IOException e) { // 속성 파일이 었다면 기본간을 모두 메모리로 읽어 들였다는 의미다. } }- 주석에 대한 답을 알아내려면 다른 코드를 뒤져보는 수밖에 없다.
- IOException이 발생하면 속성 파일이 없다는 뜻? 모든 기본값을 메모리로 읽어 들인 상태?
- 누가 모든 기본값을 읽어 들이는가?
- loadProperties.load를 호출하기 전에 읽어 들이는가? 아니면 loadProperties.load가 파일을 읽어들이기 전에 모든 기본값부터 읽어 들이는가?
- 저자가 catch 블록을 비워놓기 위해 몇 마디 덧붙였을 뿐인가?
- (만에 하나) 나중에 돌아와서 기본값을 읽어 들이는 코드를 구현하려 했는가?
- 이해가 안되어 다른 모든 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. → 바이트 낭비
-
같은 이야기를 중복하는 주석
- 아래의 함수는 헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다. (코드보다 주석을 읽는 시간이 더 오래 걸린다.)
// waitForClose // 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")； } }- 주석을 달아놓은 목적이 뭘까?
- 주석이 코드보다 더 많은 정보를 제공하지 못한다.
- 코드를 정당화 하는 주석? → Nope
- 의도나 근거를 설명하는 주석? → Nope
- 코드보다 읽기 쉬운가? → Nope
- 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.
- 기록이라는 목적에 전혀 기여하지 못하는 코드의 예시
- TomcatContainerBase.java
(쓸모없고 중복된 javadocs가 매우 많다고 한다.)
- TomcatContainerBase.java
-
오해할 여지가 있는 주석
- 의도는 좋으나 프로그래머가 딱 맞을 정도로 엄밀히 주석을 달지 못하기도 한다.
- waitForClose (2번 항목의 예시 코드) 의 오해의 여지
- this.closed가 true로 변하더라도 method의 return 값은 없는 상태.
- this.closed가 true여야 method가 return하지 않을까? 라던지
- 아니면 무조건 timeout을 기다렸다가 this.closed가 그래도 true가 아니면 예외를 던진다고 생각한다던지
- this.closed가 true로 변하더라도 method의 return 값은 없는 상태.
-
의무적으로 다는 주석
-
모든 함수에 javadocs를 달거나 모든 변수에 주석을 달라는 규칙은 어리석기 그지 없다!
-
아무런 가치가 없는 주석의 예
/** * * @param title CD 제목 * @param author CD 저자 * @param tracks CD 트랙 숫자 * @param durationInMinutes CD 길이(단위: 분) */ public void addCD(String title, String author, int tracks, int durationlnMinutes) { CD cd = new CD(); cd.title = title; cd.author = author; cd.tracks = tracks; cd.duration = durationInMinutes; cdList.add(cd); }
-
-
이력을 기록하는 주석
- 모듈을 편집한 이력을 기록하는 주석
- 예전 관례로는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 것이 바람직했다고 한다.
- 소스 코드 관리 시스템(형상 관리 시스템)이 있다면 repository에 올려두는 것으로 이력을 관리하면 된다.
-
있으나 마나 한 주석
-
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
/** * 기본 생성자 */ protected AnnuaIDateRule() { } /** 월 중 일자 */ private int dayOfMonth; // 전형적인 중복 /** * 월 중 일자를 반환한다. * * @return 월 중 일자 */ public int getDayOfMonth() { return dayOfMonth;} // 첫 catch 주석은 적절해보이지만 다음 catch의 주석은 분풀이일 뿐.. private void startSending() { try { doSending(); } catch (SocketException e) { // 정상, 누군가 요청을 멈춤. } catch (Exception e) { try { response.add(ErrorResponder.makeExceptionString(e)); response.closeAll(); } catch (Exception e1) { // 이게 뭐지? } } } -
지나친 참견이 되므로 이러한 주석을 본 개발자가 주석을 무시하는 습관에 빠진다.
-
코드가 바뀌면서 주석은 거짓말로 변한다.
-
있으나 마나 한 주석을 달 시간에 코드를 정리하자.
-
의미 없는 javadocs도 잡음이다. (문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음.)
-
-
함수나 변수로 표현할 수 있다면 주석을 달지 말 것
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가? if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem())) { } // 이 코드에서 주석을 없애고 다시 표현하면 다음과 같다. ArrayList moduleDependees = smodule.getDependSubsystems(); String ourSubSystem = subSysMod.getSubSystem(); if (moduleDependees.contains(ourSubSystem)) { }- 코드를 개선하면 주석이 필요하지 않게 된다.
-
위치를 표시하는 주석
-
소스 파일에서 특정 위치를 표시하려 주석을 사용하는 케이스
// actions //////////////////////////////////// -
가끔씩 사용하는 배너는 눈에 띄며 주의를 환기한다
-
그러나, 배너를 남용하면 독자가 흔한 잡음으로 여기며 무시한다.
-
-
닫는 괄호에 다는 주석
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.readLineO) != null) { lineCount++; charCount += line.length(); String words[] = line.split("WW"); wordCount += words.length; } //while System.out.println("wordCount = " + wordCount); System.out.println("lineCount = " + lineCount); System.out.println("charCount = " + charCount); } //try catch (IOException e) { System.err.println("Error:1" + e.getMessage()); } //catch } //main }- 중첩이 심하고 장황한 함수라면 의미가 있을지 모르지만
- 작고 캡슐화된 함수에는 잡음일 뿐이다.
- 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 함수를 줄이려 시도하자.
- 중첩이 심하고 장황한 함수라면 의미가 있을지 모르지만
-
공로를 돌리거나 저자를 표시하는 주석
- 소스 코드 관리 시스템이 있다면 굳이 없어도 되는 주석
- 저자(작성자) 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
- 이러한 주석은 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.
- 소스 코드 관리 시스템이 있다면 굳이 없어도 되는 주석
-
주석으로 처리한 코드
- 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
- 이유가 있어 남겨둔 건가?
- 중요한 내용을 주석해둔건 아닐까?
- 쓸모 없는 코드가 점차 쌓일 수 밖에 없다.
- 소스 코드 관리 시스템이 있다면 쓸모 없는 주석은 그냥 삭제하자.
- 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
-
HTML 주석
/** * 적합성 테스트 * 수행하기 위한 과업 * 이 과업은 적합성 테스트 * 수행해 결과> 추력한다. * <p/> * <pre> * 용법: * <taskdef name="execute-fitnesse-tests" * classname="fitnesse.ant.ExecuteFitnesseTestsTask" * classpathref="classpath" /> * 뜨는 * <taskdef classpathref="classpath" * resource=" tasks. properties" /> * <p/> * &U; execute-f itnesse-tests * suitepage=" FitNesse. SuiteAcceptanceTes t s" * fitnesseport="8082" * resultsdir느"${ results. dir}" * result shtnlpag은=&qu°t； fit-results, html" * classpath ref="classpath" /> * </pre> */- HTML 주석은 (주석을 읽기 쉬워야 하는) 편집기/IDE 에서조차 읽기가 어렵다.
- 웹페이지로의 변환은 도구에게 맡기자.
-
전역 정보
/** * 적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>. * * @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비트 입력 그룸을 형성한다. 이렇게 만들어진 24비트는 4개를 묶어 6비트 그룹으로 취급하며, 각각은 base64 알파벳에서 단일 자릿수로 해석된다. base64 인코딩으로 비트 스트림을 인코딩할 때, 비트 스트림은 MSB(Most Significant Bit) 우선으로 정렬되어 있다고 가정한다. 따라서, 스트림에서 첫 번째 비트는 첫 8비트 바이트에서 최상위 비트가 되며, 여덟번째 비트는 첫 8비트 바이트에서 최하위 비트가 된다. */- 주석에 흥미로운 역사, 관련없는 정보를 장황하게 늘어놓지 마라
-
모호한 관계
// 필터 바이트란 무엇인가? // +1과 관련있는 것인가? // 한 픽셀이 한 바이트인가? /* * 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다). * 그리고 헤더 정보를 위해 200바이트롤 더한다. */ this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
- 주석을 다는 목적은 코드만으로 설명이 부족해서인데
- 주석 자체가 다시 설명을 요구한다면
- 주석에 대한 주석을 달아야 할 것인가?
-
함수 헤더
- 짧은 함수는 긴 설명이 필요 없다.
- 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
-
비공개 코드에서 Javadocs
- 공개 API는 javadocs가 유용하지만 공개하지 않은 코드라면 javadocs는 쓸모가 없다.
- 시스템 내부에 속한 클래스와 함수에 javadocs를 생성할 필요는 없다.
- 유용하지 않을 뿐 아니라
- javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.
- 공개 API는 javadocs가 유용하지만 공개하지 않은 코드라면 javadocs는 쓸모가 없다.
바람직하지 못한 주석 → 바람직한 주석
해당 코드는 책 저자의 주관에 따라 리팩토링 된 코드이므로 참고용으로 보는 것이 바람직할 것 같습니다. (확실한 정답이 아님!)
/**
* 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은
* 에라스토테네스의 채다.
* <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]; // 입력이 잘못되면 비어 있는 배열을 반환한다.
}
}/**
* 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다
* 알고리즘은 에라스토테네스의 체다.
* 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 = 2 * i; 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;
}
}- 첫 번째 주석은 중복이긴 하지만 주석이 있어 알고리즘을 이해하기 쉬워진다고 생각
- 두 번째 주석은 거의 확실히 필요하다. (변수 이름 변경이나 코드 구조를 조정해 이유를 명확히 설명할 방법을 찾지 못했다 함)
- 루프 한계값으로 제곱근을 사용한 이유를 설명한다.
그동안 마신 커피와 개발 지식, 경험을 기록하는 공간