Java基础——注释

超、凢脫俗 2022-02-19 07:21 166阅读 0赞

**一、注释的定义：**  
注释，简单的来说就是一个不会被java虚拟机编译的东西，他不会展示在任何我们编译后的class文件的任何地方，最主要的功能就是让发开人员看懂被注释的代码。  
**二、为什么需要注释：**  
在我们日常编程中，有一个很重要的流程，看似可有可无，可是一份好的代码，永远不会缺少的一个东西就是注释，一个良好风格的注释，可以让之后的开发人员简单明了的认识你写的代码，以提高工作效率。注释规范目前是每个公司自己有自己的一套规范，主要是为了团队之间的协作。  
**三：注释的分类：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDA3MTQwOA_size_16_color_FFFFFF_t_70]  
在java中，我们常用的注释有三种，如上图所示，下面我们为大家展示一下三种注释的用法：  
\-1.单行注释：  
一次只能注释一行，一般是简单注释，用来简短描述某个变量或属性，代码块。

//这是一个单行注释
    代码/代码块...

\-2.多行注释：  
多行注释像是单行注释的升级版，可以在划定行内写自己的内容

/*
    这是一个多行注释
    */
    代码/代码块...

\-3.文档注释：  
可以使用多行，一般用来对**类**、**接口**、**成员方法**、**成员变量**、**静态方法**、**常量**进行说明。Javadoc可以用它来产生代码的文档。为了可读性，可以有缩进和格式控制。文档注释常采用一些Javadoc标签进行文档的特定用途描述，用于帮助Javadoc产生文档。

/**
    *这里是文档注释，这里还有几个特殊的javadoc标签，我们在下方展示
    */

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDA3MTQwOA_size_16_color_FFFFFF_t_70 1]  
**四、总结：**  
注释在java中，有着很重要的地位，在我们学习和工作中，一定要养成良好的写注释的习惯，这样给我们大家都提供了方便，可以减少很多不必要的事情发生。

--------------------

您可以通过点击 文章下方的输入框 来对文章内容作出评价, 也可以通过左上方的 关注按钮 来关注我的博客的最新动态。

如果文章内容对您有帮助, 不要忘记点击右上角的 喜欢按钮 来支持一下哦 ！

如果您对文章内容有任何疑问, 可以通过评论方式联系我;

**如果需要转载，请注明出处，谢谢！！**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDA3MTQwOA_size_16_color_FFFFFF_t_70]: /images/20220219/e63f4d5a30824e3fa4a8bdbeeb790114.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDA3MTQwOA_size_16_color_FFFFFF_t_70 1]: /images/20220219/6da6a2d2d5954c8db1c3365228fae423.png