Java千百问_03基础语法（018）_注释是什么

点击进入_更多_Java千百问

1、注释是什么

java中的注释和其他编程语言中的注释一样，注释的内容不会被编译运行，只是源代码中对代码的解释说明。

通过添加代码注释可以提高源代码的可读性，使得Java程序条理清晰，易于区分代码行与注释行。另外，通常还会在类、方法或者代码段开头加入作者、添加/修改时间、程序版本以及代码功能等内容注释，方便后来的维护以及程序员的交流。（当然，对于好的代码，不写注释也能够有很高的可读性）

2、注释如何使用

对于Java注释，我们可以添加在代码中任何地方，主要语法有如下三种：

//

注释一行，一般用来解释说明某个变量或者某行代码的含义。

/* …… */

注释若干行，注释多行写法如下：

/* ......
* ......
* ......
*/

一般用来描述某段代码的编写思路、执行过程或者注意事项。

/* * …… */

文档注释，这种写法同多行注释，不同的是，它可以通过jdk提供的javadoc工具生成代码文档（html等格式），方便形成开发文档。它不但可以多行注释，还可以添加一些标签，供生成文档使用，如下：

/**
* .........
* .........
* @author sunjie at 2016年6月18日
* @version 1.0.0
* @param name
*    名称
* @param sex
*    性别
* @return boolean  
*    是否成功
*/

这里要注意的是javadoc只提取/* * ….. */这种类型的注释。

了解javadoc看这里：[javadoc是什么][2]