java代码注释格式模板 java注释格式

如何在java程序中添加注释

1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容

公司主营业务：成都网站设计、成都网站制作、移动网站开发等业务。帮助企业客户真正实现互联网宣传，提高企业的竞争能力。创新互联公司是一支青春激扬、勤奋敬业、活力青春激扬、勤奋敬业、活力澎湃、和谐高效的团队。公司秉承以“开放、自由、严谨、自律”为核心的企业文化，感谢他们对我们的高要求，感谢他们从不同领域给我们带来的挑战，让我们激情的团队有机会用头脑与智慧不断的给客户带来惊喜。创新互联公司推出东阿免费做网站回馈大家。

2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */

3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

什么是注释？如何在Java程序中加入注释？

试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果。

Java中代码的注释有三种：

// 注释一行 

/* ...... */ 注释若干行 

/** ...... */ 注释若干行，并写入 javadoc 文档

前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

扩展资料

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

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用于提取源文件中的作者信息）