注释(commentary )是程序中用于说明和解释的一段文字对程序运行不起作用。程序 中添加注释的目的是增强程序的可读性。

  Java提供3种注释方式:。

      单行注释://

      多行注释/**/

      文档注释:

      /**

        *文档注释用于从源代码自动生成文档执行javadoc

        *命名根据源代码中的内容生成网页

        *@XXX <-- 可以加入javadoc参数产生相应的文档

     */ 

不同格式的注释可以嵌套。

// Welcome1.java. Text-printing program.

/*计信学院09软件工程2班 

**姓名XXX

**2011年2月26日1800最后修改。*/

public class Welcome1

{

// main method begins execution of application

    public static void main( String args[] ){

System.out.println( "梅花香子苦寒来!" );

}

}

文档注释参数说明

@see 生成文档中的“参见xx 的条目”的超链接后边可以加上“类名”、“完整类名”、“完整类名#方法”。可用于类、方法、变量注释。@param 参数的说明。可用于方法注释。@return 返回值的说明。可用于方法注释。@exception 可能抛出异常的说明。可用于方法注释。@version 版本信息。可用于类注释。@author 作者名。可用于类注释。

 >javadoc first.java

javadoc命令javadoc [options] [packagenames] [sourcefiles]

-public 仅显示 public 类和成员 -protected 显示 protected/public 类和成员 (缺省)-package 显示 package/protected/public 类和成员-private 显示所有类和成员-d <directory> 输出文件的目标目录-version 包含 @version 段-author 包含 @author 段-splitindex 将索引分为每个字母对应一个文件-windowtitle <text> 文档的浏览器窗口标题 

Eclipse中JavaDoc的生成方式

在项目列表中选择项目按右键选择Export导出然后在Export(导出)对话框中选择java下的javadoc。 

在Javadoc Generation对话框中有两个地方要注意的 1javadoc command:应该选择jdk的bin/javadoc.exe。 2destination:为生成文档的保存路径。 

本文出自 “11527662” 博客，请务必保留此出处http://11537662.blog.51cto.com/11527662/1846634

Java注释