龙空技术网

JAVA注释详解以及实战应用

摆技 404

前言:

现在小伙伴们对“java里注释”大体比较注意,姐妹们都想要分析一些“java里注释”的相关内容。那么小编也在网摘上网罗了一些关于“java里注释””的相关内容,希望大家能喜欢,我们一起来学习一下吧!

概述:

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

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、字段名注释

标签: #java里注释