[{"data":1,"prerenderedAt":414},["ShallowReactive",2],{"post-document:\u002Fjava\u002Fbasics\u002F2026\u002F08\u002F10\u002Fjava-comments-javadoc\u002F":3},{"id":4,"title":5,"body":6,"categories":393,"date":395,"description":396,"extension":397,"image":398,"key_concepts":398,"last_modified_at":398,"legacyPath":399,"meta":400,"navigation":153,"part":402,"path":403,"published":153,"robots":398,"seo":404,"series":405,"stem":406,"strengths":398,"summary":398,"tags":407,"tradeoffs":398,"__hash__":413},"posts\u002Fposts\u002FBackend\u002FJAVA\u002Fbasics\u002F2026-08-10-java-comments-javadoc.md","Java 기초 Part 2: 주석과 Javadoc",{"type":7,"value":8,"toc":387},"minimark",[9,13,18,101,197,201,235,284,357,368,371,383],[10,11,5],"h2",{"id":12},"java-기초-part-2-주석과-javadoc",[14,15,17],"h3",{"id":16},"java의-주석","Java의 주석",[19,20,21,40],"table",{},[22,23,24],"thead",{},[25,26,27,31,34,37],"tr",{},[28,29,30],"th",{},"구분",[28,32,33],{},"사용 문법",[28,35,36],{},"용도",[28,38,39],{},"예시",[41,42,43,64,83],"tbody",{},[25,44,45,49,56,59],{},[46,47,48],"td",{},"한 줄 주석",[46,50,51,55],{},[52,53,54],"code",{},"\u002F\u002F","로 시작",[46,57,58],{},"간단한 설명, TODO, 디버깅 등",[46,60,61],{},[52,62,63],{},"\u002F\u002F 변수 초기화",[25,65,66,69,75,78],{},[46,67,68],{},"여러 줄 주석",[46,70,71,74],{},[52,72,73],{},"\u002F* ... *\u002F","로 감싸기",[46,76,77],{},"여러 줄 설명, 블록 주석 등",[46,79,80],{},[52,81,82],{},"\u002F* 여러 줄 주석입니다 *\u002F",[25,84,85,88,93,96],{},[46,86,87],{},"문서 주석",[46,89,90,55],{},[52,91,92],{},"\u002F** ... *\u002F",[46,94,95],{},"메서드, 클래스 문서 자동화",[46,97,98],{},[52,99,100],{},"\u002F** 이름을 반환합니다 *\u002F",[102,103,108],"pre",{"className":104,"code":105,"language":106,"meta":107,"style":107},"language-java shiki shiki-themes github-light github-dark","public class Example {\n    \u002F\u002F 한 줄 주석: 사용자 이름 출력\n    public static void main(String[] args) {\n        \u002F* 여러 줄 주석:\n           변수 선언과 초기화 *\u002F\n        String name = \"Skala\";\n\n        \u002F**\n         * 사용자 이름을 출력합니다.\n         * @param name 사용자 이름\n         *\u002F\n        System.out.println(\"Hello, \" + name);\n    }\n}\n","java","",[52,109,110,118,124,130,136,142,148,155,161,167,173,179,185,191],{"__ignoreMap":107},[111,112,115],"span",{"class":113,"line":114},"line",1,[111,116,117],{},"public class Example {\n",[111,119,121],{"class":113,"line":120},2,[111,122,123],{},"    \u002F\u002F 한 줄 주석: 사용자 이름 출력\n",[111,125,127],{"class":113,"line":126},3,[111,128,129],{},"    public static void main(String[] args) {\n",[111,131,133],{"class":113,"line":132},4,[111,134,135],{},"        \u002F* 여러 줄 주석:\n",[111,137,139],{"class":113,"line":138},5,[111,140,141],{},"           변수 선언과 초기화 *\u002F\n",[111,143,145],{"class":113,"line":144},6,[111,146,147],{},"        String name = \"Skala\";\n",[111,149,151],{"class":113,"line":150},7,[111,152,154],{"emptyLinePlaceholder":153},true,"\n",[111,156,158],{"class":113,"line":157},8,[111,159,160],{},"        \u002F**\n",[111,162,164],{"class":113,"line":163},9,[111,165,166],{},"         * 사용자 이름을 출력합니다.\n",[111,168,170],{"class":113,"line":169},10,[111,171,172],{},"         * @param name 사용자 이름\n",[111,174,176],{"class":113,"line":175},11,[111,177,178],{},"         *\u002F\n",[111,180,182],{"class":113,"line":181},12,[111,183,184],{},"        System.out.println(\"Hello, \" + name);\n",[111,186,188],{"class":113,"line":187},13,[111,189,190],{},"    }\n",[111,192,194],{"class":113,"line":193},14,[111,195,196],{},"}\n",[14,198,200],{"id":199},"javadoc-주요-태그","Javadoc 주요 태그",[202,203,204,211,217,223,229],"ul",{},[205,206,207,210],"li",{},[52,208,209],{},"@param"," - 메서드 매개변수 설명",[205,212,213,216],{},[52,214,215],{},"@return"," - 반환값 설명",[205,218,219,222],{},[52,220,221],{},"@throws"," - 예외 설명",[205,224,225,228],{},[52,226,227],{},"@author"," - 작성자",[205,230,231,234],{},[52,232,233],{},"@since"," - 버전표시",[102,236,238],{"className":104,"code":237,"language":106,"meta":107,"style":107},"\u002F**\n * 주어진 두 수의 합을 반환합니다.\n * @param a 첫 번째 정수\n * @param b 두 번째 정수\n * @return 두 정수의 합\n *\u002F\npublic int add(int a, int b) {\n    return a + b;\n}\n",[52,239,240,245,250,255,260,265,270,275,280],{"__ignoreMap":107},[111,241,242],{"class":113,"line":114},[111,243,244],{},"\u002F**\n",[111,246,247],{"class":113,"line":120},[111,248,249],{}," * 주어진 두 수의 합을 반환합니다.\n",[111,251,252],{"class":113,"line":126},[111,253,254],{}," * @param a 첫 번째 정수\n",[111,256,257],{"class":113,"line":132},[111,258,259],{}," * @param b 두 번째 정수\n",[111,261,262],{"class":113,"line":138},[111,263,264],{}," * @return 두 정수의 합\n",[111,266,267],{"class":113,"line":144},[111,268,269],{}," *\u002F\n",[111,271,272],{"class":113,"line":150},[111,273,274],{},"public int add(int a, int b) {\n",[111,276,277],{"class":113,"line":157},[111,278,279],{},"    return a + b;\n",[111,281,282],{"class":113,"line":163},[111,283,196],{},[19,285,286,296],{},[22,287,288],{},[25,289,290,293],{},[28,291,292],{},"가이드 항목",[28,294,295],{},"설명",[41,297,298,306,314,322,333,345],{},[25,299,300,303],{},[46,301,302],{},"필요한 경우만 작성",[46,304,305],{},"코드 자체로 의미가 명확할 경우 불필요한 주석은 피함",[25,307,308,311],{},[46,309,310],{},"왜(Why)와 무엇(What)를 설명",[46,312,313],{},"선택한 이유, 의도, 대안 비교 또는 코드의 기능과 동작 설명",[25,315,316,319],{},[46,317,318],{},"오래된 주석 제거",[46,320,321],{},"코드가 변경되면 주석도 함께 업데이트",[25,323,324,327],{},[46,325,326],{},"Javadoc 사용 권장",[46,328,329,330,332],{},"public 클래스와 메서드는 ",[52,331,92],{}," 문서 주석 사용",[25,334,335,338],{},[46,336,337],{},"TODO \u002F FIXME 구분",[46,339,340,341,344],{},"작업 항목 추적 시 ",[52,342,343],{},"\u002F\u002F TODO: 로그인 로직 추가","처럼 명확히 작성",[25,346,347,350],{},[46,348,349],{},"API 문서 자동 생성",[46,351,352,353,356],{},"문서 주석과 ",[52,354,355],{},"javadoc"," 도구를 활용해 HTML 문서 생성 가능",[358,359,360,363,364,367],"p",{},[52,361,362],{},"\u002F\u002F TODO","와 ",[52,365,366],{},"\u002F\u002F FIXME","는 개발자가 작업 중인 코드에 메모를 남길 때 사용하는 특별한 주석 패턴이다.",[358,369,370],{},"IDE(예: IntelliJ, Eclipse)에서도 자동으로 인식되어 작업 추적(TODO 리스트) 용도로 널리 사용",[202,372,373,378],{},[205,374,375,377],{},[52,376,362],{},": 해야 할 작업(To-Do)을 기록해두는 주석",[205,379,380,382],{},[52,381,366],{},": 현재 코드에 문제가 있음을 나타내고 수정이 필요함을 알리는 주석",[384,385,386],"style",{},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":107,"searchDepth":120,"depth":120,"links":388},[389],{"id":12,"depth":120,"text":5,"children":390},[391,392],{"id":16,"depth":126,"text":17},{"id":199,"depth":126,"text":200},[106,394],"basics","2026-08-10 09:20:00 +0900","Java의 한 줄 주석, 블록 주석, Javadoc 문법과 TODO, FIXME 사용법을 정리한다.","md",null,"\u002Fjava\u002Fbasics\u002F2026\u002F08\u002F10\u002Fjava-comments-javadoc\u002F",{"layout":401},"post","2","\u002Fposts\u002Fbackend\u002Fjava\u002Fbasics\u002F2026-08-10-java-comments-javadoc",{"title":5,"description":396},"Java 기초","posts\u002FBackend\u002FJAVA\u002Fbasics\u002F2026-08-10-java-comments-javadoc",[408,409,410,411,412],"Java","Comment","Javadoc","TODO","FIXME","1VOuksYyBv8Y-P9Vlsp4Isf0wzUjXbfOYZtzcikbboU",1788744784556]