doxys 로 c + 문서 생 성

C + + 코드 를 쓰 고 설명 을 쓴 다음 에 문 서 를 자동 으로 생 성 합 니 다. 이것 은 모든 규범 적 인 C + 개발 절차 가 필요 합 니 다.오늘 doxys 를 해 봤 는데 잘 썼어 요.
Ubuntu 기기 에서 먼저 Linux 버 전의 doxys 프로그램 을 다운로드 하고 인터넷 주 소 는 다음 과 같 습 니 다.http://www.doxys.dk/doxys_homepage/homepage/Download/Download0_dir_description.html
스트레스 를 풀다
tar jxvf doxys_1_15_linux32_bin.tar.bz2

그리고 이 디 렉 터 리 에 들 어가 루트 권한 으로 실행 합 니 다.
./install_RunAsRoot.sh

설치 완료.
현재 C + + 프로젝트 디 렉 터 리 에 들 어가 서 맨 위 디 렉 터 리 에 있 으 면 됩 니 다.그리고 실행
doxys, 디 렉 터 리 구 조 를 자동 으로 검색 하고 comments 를 추출 하여 html 문 서 를 생 성 합 니 다.모든 문 서 는 doxys 에 생 성 됩 니 다.docs 디 렉 터 리 아래.
마지막 으로 doxys 가 요구 하 는 comments 쓰기 형식 이 좀 특별 합 니 다. 참고 하 세 요.http://www.doxys.dk/doxys_homepage/homepage/Documentation/Example_Code/HowToDocument0_class_description.html
내 가 사용 하 는 Google c + + style 의 요구 / / 와 는 다 릅 니 다.구 글 c + + style 을 추출 할 수 있 는 comments 를 찾기 전에 억울 하 게 / / 를 사용 하 세 요.
또는 자바 스타일 로:
/**
*/
생 성 된 문서 에 포 함 된 계승 관계 도 를 살 펴 보 는 것 도 좋 을 것 같 습 니 다.
설명 에서 인자 와 반환 유형 을 어떻게 설명 하 는 지 자바 스타일 을 선 택 했 습 니 다.참고 문서:
http://www.doxys.dk/doxys_homepage/homepage/Documentation/Example_Code/ParametersJavaStyle4173613626_member_description.html

좋은 웹페이지 즐겨찾기