我想知道什么是一些评论指南？我在
Java中编写类.我想要有可读的代码.在另一个问题中,我被告知“如何”的意见应该为困难的代码段保留.我被告知我的代码评论增加了不知道的信息.评论不仅仅是读者.他们也提醒作者他们的原意,并帮助匹配分组符号.
我是Java和Stackoverflow的新手.为什么我越来越格外我认为这个网站是为了允许程序员互相帮助.我觉得像一个目标,因为我有一个-3票的问题.我们在这里帮助新的程序员,或者在这里以别人的费用自豪地吹起我们的胸口？
解决方法
不同的人有不同的风格,所以在某种程度上,无论你在这里看到的只是一个人的建议.没有冷的,硬的评论规则.
在Java中注释最重要的是Javadocing.这是一种特殊类型的注释,可以在IDE(如Eclipse和Netbeans)中被解析和使用,以帮助编码过程更容易. Javadoc注释以/ **开始,以* /结尾就像一个常规的多行注释,但在第一个注释中有两个星号.
您将Javadoc注释放在类,方法或实例变量的开头,以描述它们的作用.在评论中格式化数据的标准方法是标签.一些常见的标签是@author和@version.您可以看到Sun的一些建议,用于在这里编写Javadoc评论：http://java.sun.com/j2se/javadoc/writingdoccomments/
我之后要做的是使用单行注释(双斜杠//)来描述我的逻辑.如果我需要多行,我只需要使用多个单行注释.这种技术的优点是,如果您需要稍后注释大量的文本,可以使用常规的多行注释/ * * /,而不用担心嵌套的注释问题.
我希望这可以帮助您了解如何在java中使用注释.我的建议部分是我为大学的Java简介课程提供的教学助理工作的一部分产品,部分来自工业界.有不同背景的人可能会有更多的建议.