簡體   English   中英

JavaDoc - 我可以將方法分成組嗎?

[英]JavaDoc - Can I divide methods into groups?

我目前正在為具有許多功能的類創建文檔。 有沒有辦法組織JavaDoc,以便概述中的方法分為幾個類別?

也許嘗試重構它,這樣你就不會在一個類中有“很多功能”。 將代碼划分為更易於維護,可讀性,測試,調試,記錄等的小部分要好得多。

JavaDoc工具沒有這樣的功能。 甚至JDK的方法也沒有以這種方式分組。

我擔心它不是Javadoc - 但是doxygen支持在輸出中對項目進行分組。

我使用doxygen而不是Javadoc用於個人項目,以及專業用於多語言項目。 文檔注釋格式在很大程度上與Javadoc足夠接近,但我發現它更豐富和可擴展,輸出更好。

哎呀,對於一個項目,我們通過doxygen發布了用戶指南和API指南作為PDF ...

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM