Java 里的注释语句是用于建立程序文档的非执行部分,也就是程序员用来标记和说明程序的部分。编译器将忽略它,对它不进行任何处理。为程序添加注释,它可以使程序更容易阅读和理解,便于开发人员之间的沟通。Java 语言体系中有3 种类型的注释语句,其语法格式如下:
1.单行注释符//
该语句从“//”开始到本行结束的所有字符都作为注释而被Java 编译器忽略,它用于单行程序语句注释。多用于对属性、变量以及算法重要转折时的提示。
2.多行注释符/* */
在/*和*/之间的任何文本都被当作注释,用于书写一行或多行注释,该注释不能互相嵌套使用。多用于对类、方法及算法的详细说明,一般在对类的注释中要有类的简要说明、创建者及修改者、创建日期和修改日期。(www.daowen.com)
3.Java 文档注释符/** */
注释符/**...*/是Java 语言所特有的文档注释,主要用于注释Java 源程序代码中的公共类、公共接口、公共变量、类和接口中的方法等。Java 除了可以采用几种常见的注释方式外,Java 语言规范还定义了一种特殊的注释,也就是所说的java-doc 注释,它是用来记录代码中的API。javadoc 注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML 标记符和专门的关键词。使用javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。例如:
在每个程序的最开始部分,一般都用javadoc 注释对程序的总体描述以及版权信息进行说明。在主程序中可以为每个类、接口、方法、字段添加javadoc 注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以添加详细的描述段落。在描述性段落之后还可以跟随一些以javadoc 注释标签开头的特殊段落,例如上面例子中@author 和@version,这些段落将在生成文档中以特定方式显示。
虽然为一个设计低劣的程序添加注释不会使其变成好的程序,但是如果按照编程规范编写程序并且为程序添加良好的注释,可以帮助用户编写出设计完美、运行效率高且易于理解的程序,尤其是在多人合作完成同一项目时,编程规范就变得更加重要。俗话说“磨刀不误砍柴工”,花费一点时间去适应一下Java 编程规范是有好处的。
免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。