java代码注释示范 java代码怎么注释

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代码加个注释（是关于try-catch-finally的学习的，尽量详细点）

package org.baoquan.example;

public class TestException { // 类的定义

public TestException() { //无参数构造方法

}

boolean testEx() throws Exception{ //定义一个方法testEx，该方法声明抛出一个Exception异常

boolean ret = true; //定义一个布尔类型的变量，并赋值为true（真）

//这是try块的开始，说明该方法内可能会有异常发生，所以对于可能有异常发生的地方，如果用户想对该异常进行处理，就用try catch来包裹他

try{

ret = testEx1(); //这个地方就是异常可能发生的地方，在方法testEx中，我们调用了testEx1方法，这个方法可能会发生异常。所以我们要来对发生异常的时候系统如果处理这个异常来做一个说明。

}catch (Exception e){//catch语句只有发生异常的时候才有可能调用。所以如果系统没有发生异常，catch中的代码是永远无法运行的。

System.out.println("testEx, catch exception"); //当系统发生异常的时候，打印"testEx, catch exception"这句，并把ret赋值为false。并抛出该异常。这个异常就有调用这个方法的方法来处理。

ret = false;

throw e;

}finally{ //finally，是不管有无异常的发生，都会运行其中的代码。所以这其中多是处理系统资源回收的代码。

System.out.println("testEx, finally; return value="+ret);

return ret;

}

/**

* 一下的都是相同道理

* @return 该方法返回布尔类型

* @throws Exception

boolean testEx1() throws Exception{

boolean ret = true; //定义一个变量ret，默认为true。

try{

ret = testEx2();

if (!ret){

return false;

}

System.out.println("testEx1, at the end of try");

return ret;

}catch (Exception e){

System.out.println("testEx1, catch exception");

ret = false;

throw e;

}

finally{

System.out.println("testEx1, finally; return value="+ret);

return ret;

}

boolean testEx2() throws Exception{

boolean ret = true;

try{

int b=12;

int c;

for (int i=2;i=-2;i--){

c=b/i;

System.out.println("i="+i);

}

return true;

}catch (Exception e){

System.out.println("testEx2, catch exception");

ret = false;

throw e;

}

finally{

System.out.println("testEx2, finally; return value="+ret);

return ret;

}

public static void main(String[] args) {

TestException testException1 = new TestException();

try{

testException1.testEx();

}catch(Exception e){

e.printStackTrace();

}

Java如何进行单行注释和多行注释？

（1）单行注释：以“ // ”开头后面接所要加的说明的内容。如下面所示： //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中，在编译的过程就会直接略过注释，只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。

（2）多行注释：以“/*”开头，以“*/”结尾。假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写，如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦，所以这时就可采用多行注释。上面的可改成：/*说明说明说明说明*/也可以这样/* 说明说明说明说明 */

（3）文档注释：以“/**”开头，以“*/”结尾。文档注释主要是生成文档的。