자동 빌드 중에 프로젝트 문서를 생성 할 수있는 방법이 있습니까?자동 빌드로 문서 생성
I은 사용자 설명서와 소스 파일 (HTML?)의 하나의 세트를 가지고, 그리고 그들로부터 생성하는 것 :의
- PDF 문서
- CHM 도움말
- HTML 버전 도움말
내용은 기본적으로 세 가지 형식 모두에서 동일합니다.
현재 저는 msbuild와 CCNET을 사용하고 있지만 필요한 경우 변경할 수 있습니다.
자동 빌드 중에 프로젝트 문서를 생성 할 수있는 방법이 있습니까?자동 빌드로 문서 생성
I은 사용자 설명서와 소스 파일 (HTML?)의 하나의 세트를 가지고, 그리고 그들로부터 생성하는 것 :의
내용은 기본적으로 세 가지 형식 모두에서 동일합니다.
현재 저는 msbuild와 CCNET을 사용하고 있지만 필요한 경우 변경할 수 있습니다.
예!
그들은 쉽게 NAnt을 통해 CruiseControl.NET와 통합 할 수 있습니다 ... PDF, RTF, HTML 등의 문서의 다른 종류를 생산합니다.
아파치 포레스트 프로젝트는 당신이 원하는 것을 제공 할 수있는 방법이 될 수도 있습니다.
일반적으로 XML로 문서를 작성하는 것이 좋습니다. 그로부터 당신은 당신이 필요로하는 무엇이든을 생성 할 수 있어야합니다.
시도해 보셨습니까 Doxygen? Windows에서도 사용할 수 있으며 모든 빌드 스크립트/프로세스에서 쉽게 통합 할 수 있어야합니다.
도움말 및 설명서는 단일 소스에서 양질의 PDF, HTML 및 CHM (및 기타 형식)을 생성 할 수 있습니다. 또한 명령 줄 인터페이스도 있습니다. 나는 버전 4를 가지고 있고 그것을 많이 좋아한다. 조건 (예 : #ifdef)을 사용하여 Windows 및 Mac 버전의 설명서를 다양한 형식으로 .bat/.csh 파일 빌드의 일부로 생성합니다. 이제 버전 5를 사용할 수 있습니다. 당신이 당신의 API를 너무 문서화 원하고, 당신은 MSBuild를 사용하는 경우
는 다음 SandCastle 빌드를 제어 할 수 DocProject을 사용하는 것이 좋습니다. (이 도구는 최종 사용자 설명서가 아닙니다 ...)
Doxygen에 대한 경험이 있습니다. 쉽고 간단하지만 나중에 문서 작업을 쉽게 처리 할 수 있도록 코드를 과도하게 작성해야합니다.