注释简单的来说就是一种说明,不能被当成执行语句执行。做为一名程序员,但我们在写代码时是顺着思路写下去的。写代码好比就是在做题。当你在做的时候你脑海时的思路很清晰,会想到用一些特殊的方法来解决当前的问题。但是但你在解决一个大型问题时。思路有很多,而且有的比较复杂,现在你现写代码时,自己心里清楚自己为什么要这么写。但时隔几天或几个月,当你再次打开你所写的代码时。你会发现一大堆代码看下来整个人会晕头转向的。会忘记当时所写的部分代码的功能或实现过程。简单的说就是会忘记当时的思路。
长沙网站制作公司哪家好,找成都创新互联!从网页设计、网站建设、微信开发、APP开发、自适应网站建设等网站项目制作,到程序开发,运营维护。成都创新互联自2013年起到现在10年的时间,我们拥有了丰富的建站经验和运维经验,来保证我们的工作的顺利进行。专注于网站建设就选成都创新互联。
而这时注释的作用就显示十分重要了。当你在写代码时。写到关键部分你可以写下一些说明(注释),说明你的思路或此段代码的功能和作用。当有了这些说明,你时隔几个月再回来看自己曾经写的代码时就能快速找回当时的思路,快速理解代码。值得提的时。以后在工作上,往往是团队合作。今天你写了几个代码。明天可能你请假,另一个人来接手你的工作。接着你的代码写下去。但如果你写代码时用到了一些别人不知道的思路时。如果没有注释,别人根本就很难理解你的代码。也就难以接手你的工作了。
说以上这些只是为了让楼主能明白注释的重要性。好了。下面正面回答楼主的问题:
上面说到。代码中可以加以注释来说明自己所写的代码的作用。在Java中有单行注释,多行注释,和文档注释。
(1)单行注释:以“ // ”开头后面接所要加的说明的内容。如下面所示:
//定义变量a
int a = 10;
//定义变量b
int b = 20;
上面的语句中,在编译的过程就会直接略过注释,只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。
(2)多行注释:以“/*”开头,以“*/”结尾。
假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写,如下所示
// 说明
//说明
//说明
//说明
以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦,所以这时就可采用多行注释。上面的可改成:
/*
说明
说明
说明
说明
*/
也可以这样
/* 说明
说明
说明
说明 */
(3)文档注释:以“/**”开头,以“*/”结尾。文档注释主要是生成文档的。楼主刚学Java可能不知道什么是API文档。因此,这里我就不说明了。以后你自然会明白。
好了就这些了。希望能帮到楼主,祝楼主学习愉快!O(∩_∩)O哈哈~
1、单行(single-line)--短注释://……
单独行注释:在代码中单起一行注释,
注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
注释格式:/*
注释内容
*/
行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式://
注释内容
行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
注释格式:代码
+
8(至少4)个空格
+
//
注释内容
2、块(block)--块注释:/*……*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
/*
*
注释内容
*/
3、文档注释:/**……*/
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
/**......*/
...
我看动力节点的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用于提取源文件中的作者信息)