为什么要给代码加注释？Java中的注释有几种？

太过爱你忘了你带给我的痛 2022-09-09 09:21 102阅读 0赞

![464bd14ec208bf7cd6fd2be95acff173.png][]

在编写程序时，为了使代码易于阅读，通常会在实现功能的同时为代码添加一些注释。

**注释是对程序的某个功能或者某行代码的解释说明，它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。**

注释只在Java源文件中有效，在编译程序时编译器会忽略这些注释信息，不会将其编译到class字节码文件中。

**Java中的注释有三种类型，具体如下：**

**1．单行注释**

单行注释通常用于对程序中的某一行代码进行解释，用符号“//”表示，“//”后面为被注释的内容，具体示例如下：

int c = 10;      // 定义一个整型变量c

**2．多行注释**

多行注释顾名思义就是可以同时为多行内容进行统一注释，它以符号“/”开头，并以符号“/”结尾，具体示例如下：

/* 定义一个整形变量x
    将5赋值给变量x */
    int x;
    x = 5;

**3．文档注释**

文档注释通常是对程序中某个类或类中的方法进行的系统性的解释说明，开发人员可以使用JDK提供的javadoc工具将文档注释提取出来生成一份API帮助文档。文档注释以符号“/”开头，并以符号“/”结尾，具体示例如下：

/**
     * Title：HelloWorld类
     * @author srx
     * @version 1.0    
     */
    public class HelloWorld {
        /**
         * 这是一个main()方法入口
         * @param args 参数名
         */
        public static void main(String[] args){
            System.out.println("这是第一个Java程序！");
        }
    }

**注释嵌套：**

在Java中，有的注释可以嵌套使用，有的则不可以，下面列举两种具体的情况。

1．多行注释“/…/”中可以嵌套使用单行注释“//”，具体示例如下：

/* int c = 10;  // 定义一个整型的c
      int x = 5; */

2．多行注释“/…/”中不能嵌套使用多行注释“/…/”，具体示例如下：

/*
      /*int c = 10;*/
      int x=5;
    */

上面第二种情况的代码就无法通过编译，原因在于第一个 “/”会和第一个“/”进行配对，而第二个“\*/”则找不到匹配，就会编译失败。

针对在使用嵌套注释时可能出现编译异常这一问题，通常在实际开发中都会避免对代码注释进行嵌套使用，只有在特殊情况下才会在多行注释中嵌套使用单行注释。

![7a36361c71166471d9dfe1e2869f6bb0.png][]

** 黑马程序员 **

**致力于培养高级软件工程师**

**96** 位专职课研技术大牛

**879** 人严选教学团队

累计培养 **30余万名** 优质IT人才

以高品质教学质量赢得好口碑

![70b0c662f2920a2885bd8f4a6e9fb089.png][]

**部分学科最高优惠2000元**

立即扫码抢占优惠名额

课程老师1对1服务，全程免费

????????????

<table> 
 <tbody> 
 <tr> 
 <td colspan="1">JavaEE</td> 
 <td colspan="1">HTML&amp;JS+前端</td> 
 <td colspan="1">Python+大数据开发</td> 
 </tr> 
 <tr> 
 <td colspan="1">人工智能开发</td> 
 <td colspan="1">UI/UE设计</td> 
 <td colspan="1">软件测试</td> 
 </tr> 
 <tr> 
 <td colspan="1">新媒体+短视频直播运营</td> 
 <td colspan="1">产品经理</td> 
 <td colspan="1">Linux云计算+运维开发</td> 
 </tr> 
 <tr> 
 <td colspan="1">智能机器人软件开发</td> 
 <td colspan="1">电商视觉运营设计</td> 
 <td colspan="1">/</td> 
 </tr> 
 </tbody> 
</table>

**线上课程也可扫码咨询**

**更多疑问可添加播妞微信**

![16e7427177fdc4c75cc1c5b0825714b7.png][]** heiniu526 **

**- 推荐阅读 -**

[有个码农老公是什么体验？网友：嫁给程序员，我超级后悔！][Link 1]

[2021-08-12][Link 1]

[![00946bc4ed96e9b93275e45e8fd54cee.png][] ][Link 1]

[百度史上首次开放超8000+个offer，这些岗位均有增加！][8000_offer]

[2021-08-16][8000_offer]

[![36b7f914a7a199fad90c861fedc05435.png][] ][8000_offer]

[国企年薪35万和美团70万，怎么选？网友支了一招，好笋！][35_70]

[2021-08-14][35_70]

[![bc620a2a932fecd5bccb48d0fae003fb.png][] ][35_70]

![a45cd10e005b3cbe3b060fb1e1d1f091.png][]

**点个在看，8月好运满满**

[464bd14ec208bf7cd6fd2be95acff173.png]: /images/20220829/1f16b163a7c5428aa5695c3a95511a42.png
[7a36361c71166471d9dfe1e2869f6bb0.png]: /images/20220829/e032abd3997e4904bbe75211ed0423b0.png
[70b0c662f2920a2885bd8f4a6e9fb089.png]: /images/20220829/6809088f676f4e0a9777b88e1903f601.png
[16e7427177fdc4c75cc1c5b0825714b7.png]: /images/20220829/f4fb5e2472a942acb8e600ed7373922d.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU0ODExNTc5MQ%3D%3D&chksm=fb465c8acc31d59c4461a809e0d6f58acc8d68b8bf10f736e0743457a34510317f1191751a72&idx=1&mid=2247555242&scene=21&sn=9ee49e3ec15394b9d0cdb9f71d253365#wechat_redirect
[00946bc4ed96e9b93275e45e8fd54cee.png]: /images/20220829/15aec281c4a742329b356406e2e7c1d7.png
[8000_offer]: http://mp.weixin.qq.com/s?__biz=MzU0ODExNTc5MQ%3D%3D&chksm=fb465ea2cc31d7b42fb180b7b133a2fdb9f20401b8b2e044be17f0384e4c7a731ccfcef9f7ad&idx=1&mid=2247555714&scene=21&sn=d80f59c0ed8824af302c9ec4afc3fd0b#wechat_redirect
[36b7f914a7a199fad90c861fedc05435.png]: /images/20220829/71b9e672eed0452cb9181b2a91514a6a.png
[35_70]: http://mp.weixin.qq.com/s?__biz=MzU0ODExNTc5MQ%3D%3D&chksm=fb465ea1cc31d7b771a88138276f5977c7d42f03ef994cfea4d93e18f17c167685ad1351208d&idx=1&mid=2247555713&scene=21&sn=7b7f3391d5cfb43ad4e233eacdd2ef9e#wechat_redirect
[bc620a2a932fecd5bccb48d0fae003fb.png]: /images/20220829/24ce59d1c3474637a2dec3ffc69510db.png
[a45cd10e005b3cbe3b060fb1e1d1f091.png]: /images/20220829/30ad447146394f10889e14b56434436a.png