Java注释约定
Java注释约定
提问于 2010-08-29 10:24:31
哪种评论方法最被广泛接受，或者它真的很重要吗？
我一直在用
/**
* (Method description)
* @param
* @return
* etc
*/然而，我读到过：
Precondition:
Postcondition:有没有更“专业”的评论方式？
回答 4
Stack Overflow用户
发布于 2010-08-29 10:36:00
第一个示例中的注释样式不仅仅是一种约定，它还是一个名为Javadoc的文档工具的标准。如果您遵循Javadoc注释样式，您将能够轻松地为所有源代码生成html格式的文档。
Stack Overflow用户
发布于 2013-09-12 13:54:04
首先，拥有可读的代码和可读的注释是两件完全不同的事情。
可读代码是使用良好的变量、方法、类名等的代码。
可读的评论更多的是个人品味的问题。有些人喜欢评论遵循语法规则，用来写一本书，而另一些人则不关心语法方面的东西。您可以通过此链接访问：
http://www.oracle.com/technetwork/java/codeconventions-141999.html#385
通过可读的代码和注释，您可以在doxygen的帮助下创建文档。
Stack Overflow用户
发布于 2010-08-29 17:04:32
我会简单地遵循Sun (Oracle)定义的编写Javadoc的标准。Javadoc被所有开发人员一致引用:)。有关详细信息，请单击here
我也会请你在search on Stackoverflow上做很多问题和评论的答案。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/3593309
复制相关文章
相似问题