java代码注释文档,java注解
Java如何进行单行注释和多行注释？
（1）单行注释：以“ // ”开头后面接所要加的说明的内容。如下面所示： //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中，在编译的过程就会直接略过注释，只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。
成都创新互联公司，专注为中小企业提供官网建设、营销型网站制作、成都响应式网站建设公司、展示型网站设计、做网站等服务，帮助中小企业通过网站体现价值、有效益。帮助企业快速建站、解决网站建设与网站营销推广问题。
（2）多行注释：以“/*”开头，以“*/”结尾。 假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写，如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦，所以这时就可采用多行注释。上面的可改成：/*说明说明说明说明*/也可以这样/* 说明 说明 说明 说明 */
（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 copy
span style="font-size:18px;"*/
/**javadoc注释的内容
*/
public class Hello{
/**属性上的注释*/
public String name;
/**这是main方法,是程序的入口
*@param args 用户输入参数
*/
public static void main(String[] args){
System.out.println("Hello World!");
f1();
}
/** 这是第1个方法,其作用是...*/
public static void f1(){
System.out.println("f1()！");
}
}/span
[java] view plain copy
span style="font-size:18px;"import java.io.IOException;
/**javadoc注释内容
*@since 1.0
*@version 1.1
*@author Blue Jey
*br链接到另一个文档{@link Hello},就这些
*see Hello
*/
public class HelloWorld{
/**非public，protected 属性上的注释不生成*/
public String name;
/**这是main方法，是程序的入口
*@param args 用户输入的参数，是数组
*@throws IOException main方法io异常
*/
public static void main(String args[]) throws IOException{
System.out.println("hello World!");
f1();
f2(1);
}
/**这是第一个方法，其作用是....
*@deprecated 从版本1.2开始，不再建议使用此方法
*/
public static void f1(){
System.out.println("fl()!");
}
/**这是第二个方法，其作用是....
*@return 返回是否OK
*@param i 输入参数i
*@see Hello
*@throws IOException io异常
*/
public static String f2(int i)throws IOException{
System.out.println("f1()!");
return "OK";
}
} /span
注意：
如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version -author
javadoc -version -author -d doc *.java
（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）
java 文档注释是注释什么的,不是有多行注释了吗?
1、【文档注释】是写在类或者方法的上面的。
文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。
使用文档注释时，需要在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。
之后，可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。
2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释 的内容可以生产一个开发者文档。
扩展资料
java常用的文档注释标签
1、@author：标识一个类的作者
实例： @author description
2、@deprecated：指名一个过期的类或成员
实例： @deprecated description
3、@exception：标志一个类抛出的异常
实例：@exception exception-name explanation
4、{@inheritDoc}：从直接父类继承的注释
实例：Inherits a comment from the immediate surperclass.
5、{@link}：插入一个到另一个主题的链接
实例：{@link name text}
6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体
实例：Inserts an in-line link to another topic.
7、@param：说明一个方法的参数
实例：@param parameter-name explanation
8、@return：说明返回值类型
实例：@return explanation
9、@see：指定一个到另一个主题的链接
实例：@see anchor
10、@serial：说明一个序列化属性
实例：@serial description
参考资料：百度百科-java注释
JAVA语言程序设计中如何进行文档注释
//单行注释 /* */多行注释 快捷键是：ctrl+反斜线 取消注释是：ctrl+斜线 同时右键可以看到添加块注释
如何写Java文档注释
1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容 2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */ 3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...
什么是java注释文档
Java有三种注释方式： 1、 // String a = "a"; 2、 /* String b = "b"; String c = "c"; */ 3、 /** String d = "d"; String e = "e"; */ 其中1和2是一样的，但1只是注释一行；2可以注释多行 3除了可以注释多行外，并且可以用JDK中的javadoc生成文档，Java的API document就是用javadoc生成的JDK源码中的第三类注释。所以第3类注释可以称之为注释文档。
希望采纳
文章题目：java代码注释文档,java注解
转载来于：http://6mz.cn/article/hdojcg.html