write - javadoc教學




Javadoc模板生成器 (4)

我有一個沒有Javadoc的大型代碼庫,我想運行一個程序來編寫一個基本的Javadoc信息的框架(例如,為每個方法的參數寫@參數...),所以我只需要填補空白。

任何人都知道這個好的解決方案?

編輯:

JAutodoc是我正在尋找的。 它有Ant任務,一個Eclipse插件,並使用Velocity作為模板定義。


如果在Eclipse中右鍵單擊文件的源代碼,則在源菜單下有一個Javadoc生成選項。


我覺得自動生成空的Javadoc是一個反模式,應該洩氣; 它為代碼提供了被記錄的外觀,但只是增加了代碼庫的噪音。

相反,我建議你配置你的代碼編輯器,以便在實際編寫javadoc時使用每個方法和每個類的基礎(一個指向Eclipse功能的評論者)。


您也可以將光標放在您想要JavaDoc的方法的上方,然後輸入:

/**

然後按Enter鍵。 這將生成您的JavaDoc存根。


你可以配置eclipse來顯示缺少javadoc的東西的警告,或者讓javadoc沒有所有的信息,或者有錯誤的信息。 它也可以插入模板供您填寫。

不是你要求的工具,但可能更好,因為你不會在你錯過的方法結束空框架。

您可以通過調查和編輯您的工作空間的路徑Window> Preferences> Java> Compiler> Javadoc之外的首選項頁面來實現此目的。 該首選項頁面的屏幕截圖如下:

有關此屏幕中項目的更多信息,請點擊以下鏈接:

Java編譯器Javadoc首選項幫助







javadoc