Java注释约定
哪种评论方法最被广泛接受,或者它真的很重要 我一直在使用Java注释约定,java,comments,Java,Comments,哪种评论方法最被广泛接受,或者它真的很重要 我一直在使用 /** * (Method description) * @param * @return * etc */ 然而,我读到: Precondition: Postcondition: 是否有更“专业”的评论方式?以下是Oracle推荐的评论Java编码约定: 以下是谷歌对其Android平台的建议: 有关Javadoc样式和约定的更多详细信息,请参见: 第一个示例中的注释样式不仅仅是一种约定,它是一种称为
/**
* (Method description)
* @param
* @return
* etc
*/
然而,我读到:
Precondition:
Postcondition:
是否有更“专业”的评论方式?以下是Oracle推荐的评论Java编码约定:
- 第一个示例中的注释样式不仅仅是一种约定,它是一种称为的文档工具的标准。如果您遵循Javadoc注释风格,您将能够轻松地为所有源代码生成html格式的文档。我只需遵循Sun(Oracle)为编写Javadoc定义的标准即可。Javadoc被所有开发人员一致引用:)。有关更多信息,请单击
我也会要求你们做以下的许多问题和回答评论
链接非常有用,我已经使用它很长时间了,对我帮助很大。这将创建一个非常好的、文档化的代码,具有最大的可读性。首先,具有可读代码和可读注释是完全不同的两件事 可读代码是使用好的变量、方法、类名等的代码 易读的评论更多的是个人品味的问题。有些人喜欢评论遵循语法规则,而有些人则不在乎语法方面的东西。您可以通过以下链接: 通过可读代码和注释,您可以在doxygen的帮助下创建文档
谷歌推荐链接可能重复的内容似乎已经消失或受到限制。也许这就是替代品?我认为Javadoc约定是最好的。有人有Oracle推荐pdf或新地址吗?