何時適合包含Java文檔？

我知道這是一個相當普遍的問題，但是我的互聯網研究沒有提供任何具體的答案。何時適合包含Java文檔？

我通常只是使用常規評論來記錄我的功能是什麼以及它們是如何做的。當我這樣做時，它看起來非常吸引人並且簡化。我對java文檔的問題是它佔用了每個函數上面的巨大空間，看起來似乎沒有必要。我承認，它可能對非常大的項目非常有用，這是我的困境出現的地方。

你應該什麼時候應該什麼時候不使用Java Docs？同行程序員什麼時候決定使用它們？

2014-07-14 jeanluc

始終..因爲在一個團隊中，它會永遠需要，併爲自己你也可能會忘記一種方法的功能。所以，好的建議 - 總之，它會使它成爲一種習慣。 – nsthethunderbolt

我不同意近距離投票，因爲回答這個問題有一個完善的工程原理。 – chrylis

一個相關的博客文章：http://android-insight.blogspot.com/2014/03/use-javadoc-use-javadoc-use-javadoc.html – aliteralmind

您JavaDoc您的代碼。期。

JavaDoc適用於使用你的代碼的人。內部評論是針對人們不需要的額外信息 - 或者不應該是 - 通常使用您的代碼時需要注意。

在瀏覽器中查看文檔，很好地格式化，始終是我的第一選擇。能夠查看你的代碼，特別是通過JavaDoc的src-html links，是一個很好的次要選項。

一些額外的信息：

2014-07-14 18:12:29 aliteralmind

更不用說，Eclipse（我假設其他的IDE）將顯示工具提示中格式良好的文檔。 – chrylis

絕對如此。如果你正在爲你創建代碼，並且只有你，那麼請評論你的喜好。但是，如果有任何機會您的代碼將被其他人使用，它必須擁有正確的文檔。如果我使用別人的課程，我不想跋涉他們的代碼來弄清楚我打算怎麼做。 – TEK

@TEK除了三個月內的「其他人」。 – chrylis

回答