공통 규칙
- 코드가 나오기 바로 전에 나와야 한다.
- 코드 작성 전에 주석을 작성한다. (미루면 80% 이상은 안하게 되니까)
- 기능 설명은 /** */, 임시는 /* ... */ , 코드 내의 짧은 주석은 //로 작성한다.
1. 함수
- 들어갈 내용 : 설명, 업데이트 날짜, 리턴값에 대한 설명, 함수 인자에 대한 설명
/** @brief 함수의 설명
* @date 함수 업데이트 날짜
* @return 리턴값에 대한설명
* @param 함수의 인자 설명
*/
2. 메인페이지
- 들어갈 내용 : 메인페이지 제목, 간략한/상세한 설명
/**
*@mainpage 메인페이지 제목
*@brief 요약설명
*@details 자세한 설명
*/
3. 파일
- 들어갈 내용 : 파일명, 간략한/상세한 설명
/**
*@file NewClass.cpp
*@brief 간략
*@details 상세
*/
4. 패키지
- 들어갈 내용 : 네임스페이스, 간략한/상세한 설명
/**
*@namespace org.nhnnext
*@brief 간략
*@details 상세
*/
5. 클래스
- 들어갈 내용 : 간략한/상세한 설명, 만든 사람 정보와 날짜, 버전명, 하는 일
/**
*@brief 간략
*@details 상세
*@author Name, Name@tistory.com
*@date 2019-06-09
*@version 0.0.1
*/
class ClassName
{
/* do nothing */
}'Java' 카테고리의 다른 글
| [Java] String, StringBuffer, StringBuilder (0) | 2022.11.20 |
|---|