不同的人有不同的风格,所以在某种程度上你在这里读到的只是某人的建议.评论没有冷酷,严格的规则.
关于Java注释,你应该知道的最重要的事情是Javadocing.这是一种特殊类型的注释,可以在IDE(如Eclipse和Netbeans)中进行解析和使用,以帮助简化编码过程.Javadoc注释以/**开头,以*/结尾,就像常规的多行注释一样,但在第一个注释中有两个星号.
您将Javadoc注释放在类,方法或实例变量的开头,以描述它们的作用.有一些标准方法可以在注释中格式化数据,这些是标记.一些常见的标签是@author和@version.您可以在此处查看Sun关于编写Javadoc注释的一些建议:http://java.sun.com/j2se/javadoc/writingdoccomments/
之后我喜欢做的是使用单行注释(双斜杠//)来描述我的逻辑.如果我需要多行,我将只使用多个单行注释.这种技术的优点是,如果您需要稍后注释掉大量文本,您可以使用常规多行注释/**/而无需担心嵌套注释问题.
我希望这可以帮助您大致了解如何在java中使用注释.我的建议部分是我在大学的Intro Java课程中获得的助教工作的一部分,部分来自于在工业界工作.其他背景不同的人可能会有更多建议.
| 归档时间： |
|
| 查看次数： |
2153 次 |
| 最近记录： |