何时适合包含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

回答