java的代码注释有几种 java的代码注释有几种类型
Java注释有几种类型
三种类型:
创新互联公司坚持“要么做到,要么别承诺”的工作理念,服务领域包括:网站建设、成都网站设计、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的洪湖网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!
1、单选注释:符号是://
2、块注释: 符号是: /* */ 可以跨多行
3、javadoc注释: 符号是: /** */ 可以跨多行, 生成javadoc时,这样的注释会被生成标准的javaapi注释。
Java 语言有哪几种注释符?
单行注释:
从“//”开始到行末结束,均视为单行注释。
多行注释:
从“/*”开始到“*/”结束,均视为多行注释。
文档注释:
从“/**”开始到“*/”结束,均视为文档注释。
文档注释与多行注释的区别:
文档注释可以用javadoc命令提取出来,生成类似于jdk文档的网页文件,以便于他人了解一个类的功能。
java中的三种注释
第一种
//单行注释
使用方法举例
int a =10
// int b=3.14 这句没有用,被注释掉了
第二种
/*
多行注释
*/
放在 /*
*/之间的代码全部会被注释
string name;
int age;
string address;
string tel;
/* private Button button1;
private Button button1;
private Button button1;
*/
上面代码所有的Button定义被注释掉了。
第三种:JavaDOC文档注释,对代码中的内容及一些内容进行描述
比如一些版本,作者信息
/**
* 文档注释
* version 1.0
* Date: 2020.10.02
* author nandasl
*/
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的代码注释有几种 java的代码注释有几种类型
文章出自:http://cdiso.cn/article/ddjjoph.html