Javadoc模板生成器

我有一個沒有Javadoc的大型代碼庫，我想運行一個程序來編寫一個基本的Javadoc信息（例如，爲每個方法的參數寫@參數...），所以我只需要填補剩下的空白。Javadoc模板生成器

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

編輯：

JAutodoc就是我一直在尋找。它具有Ant任務，一個Eclipse插件，並使用Velocity作爲模板定義。

來源

2008-08-27 Alotor

的JAutodoc Eclipse插件不正是你所需要的，但有一個包粒度：

右鍵單擊一個包，選擇「添加的Javadoc會員...」和骨架將被添加。

有許多有趣的選項：對於javadoc的模板，在每個文件的頭部添加TODO說：「模板的Javadoc，必須填寫...」等

來源

2008-08-28 10:02:10

我已經閱讀了這個插件的文檔，它提供了非常自動化的方法來爲你的方法，變量，參數等添加JavaDoc註釋。但是如果你不編輯自動生成的註釋使它們「最好的解釋「，它不會超過你的代碼中的許多線路噪聲... – Taner 2014-08-02 08:15:29

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

來源

2008-08-27 08:05:52 Silas

我沒有看到它的源菜單下，有沒有這我缺少的設置？ – Joe 2010-02-11 10:13:33

我不知道 - 它一直都在我身邊:( – Silas 2010-02-11 15:08:26

對我來說，它是Source - > Generate Element Comment – Victor 2012-09-10 18:35:53

您可以配置Eclipse來顯示警告對於缺乏javadoc的東西，或者擁有沒有所有信息的javadoc，或者有錯誤的信息。它也可以插入模板供您填寫。

不是你要求的工具，但可能更好，因爲你不會在你錯過的方法上得到空的骨架。

您可以通過調查和編輯偏好頁面，使其超出窗口>首選項> Java>編譯器> Javadoc作爲工作空間。該首選項頁面的截圖如下：

The so-called Javadoc preference page

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

Java Compiler Javadoc Preferences Help

來源

2008-08-28 10:06:34 izb

我認爲自動生成空的Javadoc是反模式，應該氣餒;它爲代碼提供了被記錄的外觀，但只是增加了代碼庫的噪音。

我建議您改爲配置代碼編輯器，以便在實際編寫javadoc時使用每個方法和每個類的基礎（一個指向Eclipse功能的註釋器）。

來源

2008-09-15 16:35:34 davetron5000

您也可以將光標放在上面，你想的JavaDoc的方法行，然後鍵入：

/**

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

來源

2013-05-09 22:37:21 Booger

選擇方法您要添加的Javadoc和ALT +移+Ĵ，自動生成javadoc註釋。

例：

/** 
    * @param currDate 
    * @param index 
    * @return 
    */ 
    public static String getAtoBinary(String currDate, int index){ 
     String HourA = "0"; 
     try{ 
      String[] mydate = currDate.split("/"); 
      HourA = mydate[index].substring(1, 2); 
     }catch(Exception e){ 
      Log.e(TAG, e.getMessage()); 
     } 
     return HourA; 
    }

來源

2014-08-28 21:32:36 Jorgesys

Javadoc模板生成器

回答

相關問題