本文目录一览：
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文档注释
/**
* @author
* @param name
* @copy
*/
表示的是文档注释，文档注释里可以以作者名，参数的意义，版本等等。对于方法的文档注释，可以在方法的上面输入“/**”按回车，就会出来了
java中” /** */”注释和” /* */”注释 有什么区别吗？
1、/**/只代表单纯的注释 ，java文档注释
2、/***/ 不仅有注释的功效而且你鼠标放在你注释的方法上面他会把你注释的内容显示出来，
3、只要把鼠标放在你注释的方法或属性上就会显示了
Java如何进行单行注释和多行注释？
（1）单行注释：以“ // ”开头后面接所要加的说明的内容。如下面所示： //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中，在编译的过程就会直接略过注释，只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。
（2）多行注释：以“/*”开头，以“*/”结尾。 假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写，如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦，所以这时就可采用多行注释。上面的可改成：/*说明说明说明说明*/也可以这样/* 说明 说明 说明 说明 */
（3）文档注释：以“/**”开头，以“*/”结尾。文档注释主要是生成文档的。
原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/200150.html
微信扫一扫 
支付宝扫一扫 