문제 설명
간단한 방법으로 javadoc을 내보내거나 구문 분석하는 도구가 있습니까? (Are there any tools to export/parse javadocs in simple way?)
javadocs에서 텍스트 파일이나 csv
테이블을 생성하는 도구가 있습니까?
내가 찾은 도구는 IDEA 표준 .html
문서 작성기뿐이었습니다. . 그러나 출력을 구문 분석하기가 어렵습니다. com.sun.javadoc
라이브러리도 찾았지만 더 이상 사용되지 않고 복잡하며 정적 코드 분석에 대한 자세한 내용을 담고 있으며 프로젝트의 모든 문서를 복사하고 싶습니다.
저는 내 Java 응용 프로그램(IDEA 프로젝트)용 MS Word에서 프로그램 설명서를 만들려고 합니다. 나는 모든 javadoc을 .csv
, .txt
또는 다른 방법으로 내보낸 다음 docx4j
를 통해 테이블로 워드 문서를 생성하기로 결정했습니다. 하지만 계획의 첫 번째 문제에서 막혔습니다.
참조 솔루션
방법 1:
Finally, I decided to do it in a half‑manual way...
- Generate HTML documentation via
IDEA > tools > Generate JavaDocs > for whole project
- Then, for each file in each package directory (
doc_root\<package name>\<class name>.html
) covert it using pandoc to docs:pandoc <class name>.html ‑f html ‑t docx ‑s ‑o table.docx
(UPD. Online pandoc word generator https://www.onlineconverter.com/html‑to‑docx) - Open each file in MS Word, remove odd data, fix table columns margins and padding and add borders. Copy tables in one large document
</ol>
(by Александр М、Александр М)