"Doxygen"의 두 판 사이의 차이
jjuiddong
(→문법 정리) |
(→문법 정리) |
||
| (한 사용자의 중간의 편집 1개 숨겨짐) | |||
| 19번째 줄: | 19번째 줄: | ||
** @param [string] : 파라메터 설명 | ** @param [string] : 파라메터 설명 | ||
** @return [string] : 리턴값 설명 | ** @return [string] : 리턴값 설명 | ||
| − | |||
* 클래스 주석 | * 클래스 주석 | ||
** 클래스 선언 위에 /// 주석은 짧은 클래스 설명을 나타낸다. | ** 클래스 선언 위에 /// 주석은 짧은 클래스 설명을 나타낸다. | ||
** 클래스 위의 /** ~ */ 주석은 클래스의 자세한 설명을 나타낸다. | ** 클래스 위의 /** ~ */ 주석은 클래스의 자세한 설명을 나타낸다. | ||
| − | * | + | * 그 밖에 공통 기능 |
| − | * -/+ 리스트 출력 | + | ** -/+ 리스트 출력 |
| − | * 탭 후 -/+ 서브 리스트 출력 | + | ** 탭 후 -/+ 서브 리스트 출력 |
| − | * #으로 글의 굵기를 지정할 수 있다. | + | ** #으로 글의 굵기를 지정할 수 있다. |
2013년 3월 15일 (금) 20:28 기준 최신판
[편집] Doxygen 이란
- Doxygen 은 소스코드 주석을 문서화 해주는 툴
- Doxygen 설치 방법과 간단한 사용법 강좌
- Doxygen 공식 매뉴얼
[편집] 문법 정리
- /** ~ */, /// 문서화되는 주석 방식
- 프로젝트 설명 주석
- @mainpage [string]
- @section [string]
- @subsection [string]
- @code : 코드 삽입
- @endcode : 코드 삽입 종료
- 함수 주석
- @brief : 함수 설명
- @param [string] : 파라메터 설명
- @return [string] : 리턴값 설명
- 클래스 주석
- 클래스 선언 위에 /// 주석은 짧은 클래스 설명을 나타낸다.
- 클래스 위의 /** ~ */ 주석은 클래스의 자세한 설명을 나타낸다.
- 그 밖에 공통 기능
- -/+ 리스트 출력
- 탭 후 -/+ 서브 리스트 출력
- #으로 글의 굵기를 지정할 수 있다.
