간단한 방법으로 javadoc을 내보내거나 구문 분석하는 도구가 있습니까? (Are there any tools to export/parse javadocs in simple way?)


문제 설명

간단한 방법으로 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...

  1. Generate HTML documentation via IDEA > tools > Generate JavaDocs > for whole project
  2. 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)
  3. Open each file in MS Word, remove odd data, fix table columns margins and padding and add borders. Copy tables in one large document

  4. </ol>

    Finally, got standard formatted Word documentation!

    (by Александр МАлександр М)

    참조 문서

    1. Are there any tools to export/parse javadocs in simple way? (CC BY‑SA 2.5/3.0/4.0)

#Documentation #intellij-idea #javadoc #java






관련 질문

터미널에서 XCode docset 문서 보기 (View XCode docset docs from terminal)

ArrayList 생성자에 대한 JDK API 문서가 올바르지 않습니다. 버그인가요? (JDK API documentation is incorrect for ArrayList constructor. Is that a bug?)

스칼라의 변수 문서 (Variables documentation in Scala)

재정의된 메서드에 대한 신속한 문서 주석? (Swift documentation comments for overriden methods?)

이미 존재하는 doxygen 문서를 상호 참조하는 방법은 무엇입니까? (How to cross-reference already existing doxygen docs?)

Spring Mock mvc 호출에 객체 속성 전달 (Pass object attrbute to spring Mock mvc call)

docfx를 사용하여 참조 문서를 생성하는 방법 (How to generate documentation with references using docfx)

get_token_user_sub() 함수는 무엇을 해야 합니까? (What is the function get_token_user_sub() supposed to do?)

UML/XMI 파일을 StarUML로 가져오는 방법은 무엇입니까? (How to import any UML/XMI files to StarUML?)

문서화 오류 Jazzy "0% 문서화되지 않은 기호가 포함된 문서 적용 범위" (documenting error Jazzy "0% documentation coverage with 0 undocumented symbols")

간단한 방법으로 javadoc을 내보내거나 구문 분석하는 도구가 있습니까? (Are there any tools to export/parse javadocs in simple way?)

JSON 스키마 기반 문서 (Documentation based on JSON Schema)







코멘트