不同的人有不同的风格,因此在某种程度上您在这里阅读的内容都只是某人的建议。没有冷酷,难以发表评论的规则。
关于Java注释,您应该知道的最重要的事情是Javadocing。这是一种特殊的注释,可以将其解析出来并在IDE(例如Eclipse和Netbeans)中使用,以帮助简化编码过程。Javadoc注释以/
*开头,以 /结尾,就像常规的多行注释一样,但第一个注释中带有两个星号。
您可以将Javadoc注释放在类,方法或实例变量的开头,以描述它们的作用。有一些格式化注释中数据的标准方法,即标签。一些常见的标签是@author和@version。您可以在此处查看Sun提出的有关编写Javadoc注释的建议:http
:
//java.sun.com/j2se/javadoc/writingdoccomments/
之后,我想做的是使用单行注释(双斜杠//)来描述我的逻辑。如果我需要多个行,我将只使用多个单行注释。这种技术的优势在于,如果您以后需要注释掉大范围的文本,则可以使用常规的多行注释/* * /而不用担心嵌套注释问题。
我希望这可以帮助您大致了解如何在Java中使用注释。我的建议部分是我在大学Intro
Java课堂上担任助教工作的产物,另一部分是从行业工作中获得的。其他背景不同的人可能会有更多建议。



