我已经完成了我的Java / Android项目,现在我需要注释代码(主要是类和重要方法).

我需要遵循最好的工业标准,如果其他人需要修改,那么它应该是明星前进.

我阅读了很多文章,发现了3种主要的java评论风格.

>单行评论(// …..)
>阻止评论(/ * ……. * /)
>文件评论(/ ** ……. * /)

我主要阅读选项2和3. Stack overflow discussions

所以我考虑使用第二个选项,因为我不需要生成HTML文档,因为这些类不会被任何其他人使用,这就是这个应用程序的实现.

想知道块注释中的最佳实践是什么,表示方法或类的“返回”类型,“参数”和“简称描述”.

想听听java代码评论的最佳行业标准做法.

提前致谢…！！！

解决方法:

我建议使用第3个选项,因为如果有人通过支持JavaDOC的IDE(例如Eclipse)查看您的代码,它将显示他/她在悬停在其上时检查的对象的相关信息.他/她感兴趣的元素.

这样,开发人员就不必打开实际的类源文件来了解它的合同是什么,它做了什么,或者在使用它时你需要注意的是什么异常.

您可以通过@see等JavaDOC钩子将相关的类/方法链接在一起.

就个人而言,我通常喜欢将DOC评论至少放在我的班级和公共方法上,对于私人方法我通常不会看到很多用于DOC评论,因为我通常不会生成JavaDOC HTML.除了DOC注释之外,我通常倾向于使用单行注释,并且当我觉得1个句子不足以表达我想要的内容时,或者当打印边距限制发挥作用时,仅使用块注释.