首页 ❯

Java 注释约定 [已关闭]

java comments
2022-09-02 01:38:41

哪种评论方法最被广泛接受，或者它真的重要吗？

我一直在使用

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

但是，我读到：

Precondition:
Postcondition:

有没有更“专业”的评论方式？


答案 1

以下是 Oracle 推荐的注释的 Java 编码约定：

以下是谷歌对其Android平台的建议：

有关 Javadoc 的样式和约定的更多详细信息，请参阅此处：


答案 2

第一个示例中的注释样式不仅仅是一个约定，它是名为 Javadoc 的文档工具的标准。如果您遵循Javadoc注释样式，您将能够轻松地为所有源代码生成html格式的文档。


推荐
更多 »
标签
更多 »
php pass-by-reference optional-parameters default-value javascript arrays dom function string object serialization tostring visibility syntax jslint use-strict operators equality equality-operator identity-operator datetime timestamp date-arithmetic redirect angularjs loops foreach iteration scope variables
推荐
更多 »