JAVA注释

程序注释是对一段代码的解释说明，一般的程序设计语言都包含的有注释，通过注释可以让别人能够读懂你所写的代码，方便与团队进行合作。程序中的注释不是程序的语句部分，它可以放在任何地方，系统在编译时会忽略掉。

同时也可以给本人做一个解释，或许写代码的时候知道自己的类名与代码功能，但当过了一段时间之后回过头再来看这段代码就不太明白了，这时注释就起到了很大的作用。

java注释大致可分为两部分：

程序注释

目录

一、程序注释

二、文档注释

---

一、程序注释

程序注释可分为单行注释与多行注释

1、单行注释

单行注释以双斜杠   //   开始,一般位于程序的开头，单行注释一般独占一行。

快捷键为Ctrl+/

 2、多行注释

多行注释也叫做块注释，多行注释以/*........*/格式出现，中间的......为注释内容，快捷键为

Ctrl+shift+/：块注释

二、程序注释

程序注释可分为文档注释、类注释、属性注释、方法注释。

程序文档注释是一种特有的注释方式，其目的是自动生成独立的程序文档。

文件注释一般以

/*

*

*

*/

出现，内部的星号（*）为程序内容

文档注释配合javadoc使用

javadoc可快速生成一个api参考网页

javadoc使用方法：菜单栏中的工具（tool）中的javadoc进入其中选择要添加的注释

在Locale栏中填入zh_CN

在command line arguments中填入-charset utf-8 -encoding utf-8 -

windowtitle CRM管理系统 *.java 选择完毕之后选择下方的生成（Generate）创建完毕即可生成手册

手册位置在idea/ bin文件夹下jlink.exe

以下为要添加的注释名称

-author作者

-version版本

-charest字符集

-encoding编码

-zh CN语言

总之，在实际的开发过程中，很多人会觉得注释没有用，但实际上事实恰恰相反，一个好的注释习惯可以让你在学习过程中记住的东西更多，在回过头在复习的时候也会方便起来。就算是到了工作里面，在公司交接时，通过代码注释也可以让团队工作变得更加的轻松。