重庆分公司,新征程启航
为企业提供网站建设、域名注册、服务器等服务
试想一下,一个没有一句注释的程序源码,怎么读,一个程序要上万条代码不可能全部记得住哪一块是什么用,而且一个项目也不会是一个人独自完成,那样效率太低,多人合作就要给别人说明,每一块是什么用,方便他人使用,方便自己更正,而这些说明文字就是注释,注释不会被执行,不影响运行结果。
网站建设哪家好,找创新互联建站!专注于网页设计、网站建设、微信开发、小程序设计、集团企业网站建设等服务项目。为回馈新老客户创新互联还提供了济水街道免费建站欢迎大家使用!
Java中代码的注释有三种:
// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行,并写入 javadoc 文档
前两种比较容易理解,至于第三种,你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。
扩展资料
注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。
注释符就是用来标记注释的符号,Java中有3种注释符号
1. 单行注释:
从“//”开始到行末结束,均视为单行注释。
2. 多行注释:
从“/*”开始到“*/”结束,均视为多行注释。
3. 文档注释:
从“/**”开始到“*/”结束,均视为文档注释。
所谓文档注释,是指用javadoc命令可以提取为Java API文档的注释内容,也就是类的注释和方法的注释。
Java中没有标识符的概念,有标识的概念。标识是指包名、类名、方法名、变量名、参数名。在你的代码中,比如类名 slra、方法名 main、参数名 args,这些是标识
我看动力节点的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用于提取源文件中的作者信息)
一、作用:1、可以大大的提高开发效率。代码量非常大的项目,在某一行中需要在后续阶段实现一个功能,如果不标注下次再找的时候就非常困难了。2、在团队合作中,还可以告诉别人某处敏感代码的状态。
二、以下为常见的两种注释标记:1、// TODO: 表示在此处将要实现的功能,提醒你在后续阶段将会在此处添加代码

2、// FIXME: 表示此处的代码逻辑有出入,或者根本不能运行,提醒你在后续阶段将会修改此处代码

3、// 在Eclipse中可以自定义标记
例如: // XXX:表示此处的代码虽然实现了功能,但是性能太低,提醒你需要在后续阶段优化;
单行注释:
从“//”开始到行末结束,均视为单行注释。
多行注释:
从“/*”开始到“*/”结束,均视为多行注释。
文档注释:
从“/**”开始到“*/”结束,均视为文档注释。
文档注释与多行注释的区别:
文档注释可以用javadoc命令提取出来,生成类似于jdk文档的网页文件,以便于他人了解一个类的功能。
这个是 java 注释用的:
java 的三种类型:
1、单选注释:符号是://
2、块注释: 符号是: /* */ 可以跨多行
3、javadoc注释: 符号是: /** */ 可以跨多行, 生成javadoc时,这样的注释会被生成标准的javaapi注释。