引用性注释和解释性注释

核心提示概述几乎所有编程语言都允许程序员在代码中输入注释,编译器会忽略注释的内容。因此,注释不会影响程序的运行结果。注释的真正作用是:它可以向任何阅读代码的人描述或者解释程序的实现思路、如何使用以及其他任何相关信息。JAVA中的注释JAVA提供了三

摘要

几乎所有的编程语言都允许程序员在代码中输入注释,编译器会忽略注释。因此,注释不会影响程序的运行结果。注释的真正作用在于,它可以向任何阅读代码的人描述或解释程序的实现思想、如何使用以及其他任何相关信息。

JAVA中的注释

JAVA提供了三种注释方法,方便我们在不同的场景下使用:

1.单行注释

如果程序中的每一行都以//开头,那么这一行就是单行注释,例如:

2.多行注释

程序中以结尾,中间的都是注释。虽然该注释被称为多行注释,但是注释的内容可以是单行的或多行的,例如:

3.javadoc注释

Javadoc注释也称为存档注释和解释性注释。开头是结尾,例如:

因为注释的内容可以是任意字符,如果我们仔细对比一下多行注释和javadoc注释,会发现如果把javadoc注释开头的第二个*作为注释内容,就会变成多行注释。从这个角度来说,我们可以说javadoc注释是一种特殊的多行注释。但这样的结果是错误的,因为javadoc注释的用处在于它允许我们在程序中嵌入关于程序本身的信息,Javadoc的工具软件通过识别这些信息输出指令文档的HTML版本。这一点至关重要,尤其是在实际项目中。

在javadoc注释中,我们通过一些标签记录程序信息。javadoc工具软件可以识别的标签如下图所示:

Javadoc注释一般用于注释类和方法,类或方法的信息是通过上表中的标签记录的,比如:

我们可以使用javadoc工具来处理NumberTest.java文件:

经过javadoc软件处理后,我们得到如下一些解释性的html文件:

当我们打开index.html时,我们看到的是对NumberTest类的描述:

看到这个结果,你知道你平时看的那些JDK的API是怎么来的吗?这就是javadoc注释的巨大作用。

注解在实战中的应用

在企业级产品开发中,对注释的要求取决于项目的规模和团队的正规化程度。对于一个专业的软件开发人员来说,javadoc的应用有时候直接决定了这个项目的作用,也影响了面试结果和薪资水平,因为它可以反映出开发人员曾经参与过的项目的规模,以及他之前隐藏在团队中的专业化程度。

重视注解是专业团队必不可少的一部分。一般来说,每个专业团队对注解都有一个编写规范要求。这里我给出注释规范供你参考:

1.版权说明

2.班级评论

3.施工方法说明

4.其他方法的注意事项

5.代码块注释

6.单句注释

7.字段名注释

 
友情链接
鄂ICP备19019357号-22