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