Java评论公约

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (15)

哪种评论方式被广泛接受或者真的很重要?

我一直在使用

/**  
 * (Method description)
 * @param
 * @return
 * etc
 */

不过,我读过:

Precondition:
Postcondition:

是否有更专业的评论方式?

提问于
用户回答回答于

首先,所有具有可读代码和可读的注释都是两件完全不同的事情。

可读代码是使用好的变量,方法,类名等代码。

可读的评论更多的是个人品味的问题。有些人喜欢评论,以遵循用来写书的语法规则,而另一些人则不太关心语法问题。你可以通过这个链接:

http://www.oracle.com/technetwork/java/codeconventions-141999.html#385

从可读代码和评论中,您可以在doxygen的帮助下创建文档。

http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html

扫码关注云+社区