顯示警告，如果方法描述丟失

在我們的代碼庫，我看到了很多像有方法：顯示警告，如果方法描述丟失

/** 
    * @param tagID 
    * @param startDate 
    * @param endDate 
    * @param estimated 
    * @return 
    * @throws ServerException 
    */ 
    List<String> generateMaster(int tagID, Date date) 
      throws ServerException, BusinessException;

雖然有一個javadoc目前，方法的描述丟失。因此，javadoc顯然是無用的。在checkstyle中，我做了什麼以便它對上述情況給出警告。

<property name="allowMissingJavadoc" value="false"/>

這隻會檢查是否存在javadoc存在與否。當javadoc存在時，它將上述方法標記爲present。但方法聲明實際上是缺失的。 PS：標記eclipse和intellij。我很高興與它告訴我的上述含類似的javadoc

來源

2015-03-03 Jatin

「方法的描述丟失了，因此javadoc顯然是無用的」。這是無稽之談。方法的名稱和參數名稱本身應該精確地告訴方法正在做什麼或應該做什麼。 imo，如果沒有提供javadoc文檔，您不應該停止編譯代碼。只有當你的代碼寫得很糟糕時才需要Javadoc，沒有它就無法理解，那麼爲什麼不讓代碼儘可能清晰？ – Stultuske 2015-03-03 11:58:10

我們的CheckStyle用這個方法的Javadoc數量的任何解決方案：

<module name="JavadocStyle"> 
    <property name="severity" value="warning"/ 
    <property name="checkEmptyJavadoc" value="true"/> 
</module>

正如你看到的checkEmptyJavadoc應該幫助你。

來源

2015-03-03 11:56:58 pepuch

如果這項工作，我發誓我會獎勵你一個賞金。最後2小時用於它 – Jatin 2015-03-03 11:57:45

它將在2天內提供賞金。那麼我會獎勵它。謝謝 – Jatin 2015-03-03 12:40:19

顯示警告，如果方法描述丟失

回答

相關問題