PROGRAMMING/JAVA 썸네일형 리스트형 JavaDoc을 쓰기 위한 주석달기 방법 1. 주석의 개념- 코드에 대한 개요와 코드에 대한 부가설명 제공- 프로그램을 읽는 것과 이해하는 것에 관한 정보만을 포함하고 있어야 함- 중복된 주석은 피해야 함- 주석을 추가해야만 할 정도의 프로그램이라면 재작성을 고려해야 함- 특수문자를 포함하면 안됨 2. 주석 작성 방법1) "/* */"에 의해 경계가 결정되는 것을 '구현 주석'이라 하는데, 개별적 구현에 대한 주석이며 코드와는 무관한 주석이다. 2) "/** */"에 의해 경계가 결정되는 것을 '문서 주석'이라 하는데, javadoc 툴을 이용하여 HTML파일로 축출한다.* @date라는 자바독 주석은 없다. API문서화하는데 문제는 없지만 생성하는 중 경고가 생긴다. * 메소드 위에 작성하는 문서 주석(/** */) 사이에 글만 써놓는다면 A.. 더보기 이전 1 2 다음
