java里注释
‘壹’ java中的注释可分为三种类型
Java中三种类型的注释：
单行注释：// 注释内容
多行注释：/*... 注释内容....*/
文本注释：/**.. 注释内容....*/
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。
(1)java里注释扩展阅读：
类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。
‘贰’ java注释里的这些标记分别是什么意思
方法/步骤
java注释，总共有3种注释方法。
注意事项
注释内容是不被编辑的内容，只是解释说明
注释，为了更方便的阅读
每次单行注释、多行注释，要选中要注释的内容
‘叁’ java 中的几种注释方式
我看动力节点的java基础大全301集教中的三种注释方法：
1、单行注释 //注释的内容
2、多行注释/*......*/
3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。
下面介绍一下Javadoc的标记：
特别声明：
（1）javadoc针对public类生成注释文档
（2）javadoc只能在public、protected修饰的方法或者属性之上
（3）javadoc注释的格式化：前导*号和HTML标签
（4）javadoc注释要仅靠在类、属性、方法之前
下面主要举例说明第三种注释的应用：
（1）首先编写.java文件
（2）在命令行中执行以下dos命令：
javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档
//javadoc标记：是@开头的，对javadoc而言，特殊的标记。
（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件
附上代码：
[java]view plain
<spanstyle="font-size:18px;">*/
/**javadoc注释的内容
*/
publicclassHello{
/**属性上的注释*/
publicStringname;
/**这是main方法,是程序的入口
*@paramargs用户输入参数
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**这是第1个方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()！");
}
}</span>
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注释内容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>链接到另一个文档{@linkHello},就这些
*seeHello
*/
publicclassHelloWorld{
/**非public，protected属性上的注释不生成*/
publicStringname;
/**这是main方法，是程序的入口
*@paramargs用户输入的参数，是数组
*@throwsIOExceptionmain方法io异常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**这是第一个方法，其作用是....
*@deprecated从版本1.2开始，不再建议使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**这是第二个方法，其作用是....
*@return返回是否OK
*@parami输入参数i
*@seeHello
*@throwsIOExceptionio异常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
[java]view plain
注意：
如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version-author
javadoc-version-author-ddoc*.java
（其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息）
‘肆’ Java 语言有哪几种注释符
单行注释：
从“//”开始到行末结束，均视为单行注释。
多行注释：
从“/*”开始到“*/”结束，均视为多行注释。
文档注释：
从“/**”开始到“*/”结束，均视为文档注释。
文档注释与多行注释的区别：
文档注释可以用javadoc命令提取出来，生成类似于jdk文档的网页文件，以便于他人了解一个类的功能。
‘伍’ 如何写Java文档注释
如何写Java文档注释(Java Doc Comments)
本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西
本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释
业余时间整理，难免有遗漏或错误，如有发现欢迎指正
转载地址：网页链接
文档注释概览
“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。
文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。
比如：
/**这是文档注释*/
/* 这是一般注释*/
// 这是一般注释
在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。
此外，文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。
文档注释采用HTML语法规则书写，支持HTML标记(tag)，同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了javadoc工具更好地生成最终文档。所以，虽然有些标记写起来麻烦且看着不直观，还是要老老实实按规矩写滴。
原文地址：网页链接