java注释see

1. 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

• <spanstyle="font-size:18px;">*/

• /**javadoc注释的内容

• */

• publicclassHello{

• /**属性上的注释*/

• publicStringname;

• /**这是main方法,是程序的入口

• *@paramargs用户输入参数

• */

• publicstaticvoidmain(String[]args){

• System.out.println("HelloWorld!");

• f1();

• }

• /**这是第1个方法,其作用是...*/

• publicstaticvoidf1(){

• System.out.println("f1()！");

• }

• }</span>

[java]view plain

• <spanstyle="font-size:18px;">importjava.io.IOException;

• /**javadoc注释内容

• *@since1.0

• *@version1.1

• *@authorBlueJey

• *<br>链接到另一个文档{@linkHello},就这些

• *seeHello

• */

• publicclassHelloWorld{

• /**非public，protected属性上的注释不生成*/

• publicStringname;

• /**这是main方法，是程序的入口

• *@paramargs用户输入的参数，是数组

• *@throwsIOExceptionmain方法io异常

• */

• publicstaticvoidmain(Stringargs[])throwsIOException{

• System.out.println("helloWorld!");

• f1();

• f2(1);

• }

• /**这是第一个方法，其作用是....

• *@deprecated从版本1.2开始，不再建议使用此方法

• */

• publicstaticvoidf1(){

• System.out.println("fl()!");

• }

• /**这是第二个方法，其作用是....

• *@return返回是否OK

• *@parami输入参数i

• *@seeHello

• *@throwsIOExceptionio异常

• */

• publicstaticStringf2(inti)throwsIOException{

• System.out.println("f1()!");

• return"OK";

• }

• }</span>

注意：

如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version-author

javadoc-version-author-ddoc*.java

（其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息）

2. Java中文档注释各字段的含义是什么例如author表示作者，para表示参数等

常用Java注释标签（Java comment
tags）

@author 作者

适用范围：文件、类、方法

（*多个作者使用多个@author标签标识，java
doc中显示按输入时间顺序罗列。）

例：*
@author Leo. Yao

@param 输入参数的名称 说明

适用范围：方法

例：* @param str
the String用来存放输出信息。

@return 输出参数说明

适用范围：方法

例： *
@return <code>true</code>执行成功;

* <code>false</code>执行失败.

@since
JDK版本

用于标识编译该文件所需要的JDK环境。

适用范围：文件、类

例： * @since
JDK1.6

@version 版本号

用于标识注释对象的版本号

适用范围：文件、类、方法

例： * @version 1.0

@see 链接目标

表示参考。会在java 文档中生成一个超链接，链接到参考的类容。使用中的感觉是@see不需要包路径，对我这种懒人比较喜欢，相对{@link
}这种既要加大括号，有需要包路径，我还是选择偷懒，当然你要是不介意使用import导入要link的类，那就可以达到@see的效果，所以总体来说，还是选择@see，当然两个在特殊场合下还是用法不一样的

用法：

@see
#field

@see #Constructor(Type,
Type...)

@see #Constructor(Type id, Type
id...)

@see #method(Type,
Type,...)

@see #method(Type id, Type,
id...)

@see
Class

@see
Class#field

@see Class#Constructor(Type,
Type...)

@see Class#Constructor(Type id,
Type id)

@see Class#method(Type,
Type,...)

@see Class#method(Type id, Type
id,...)

@see
package.Class

@see
package.Class#field

@see
package.Class#Constructor(Type, Type...)

@see
package.Class#Constructor(Type id, Type id)

@see package.Class#method(Type,
Type,...)

@see package.Class#method(Type
id, Type, id)

@see
package

@throws 异常

标识出方法可能抛出的异常

适用范围：方法

例： * @throws IOException If an input or output
exception occurred

@deprecated 解释

标识对象过期

适用范围：文件、类、方法

@link 链接地址

链接到一个目标，用法类似@see。但常放在注释的解释中形如{@link …}

例：

/**

* @deprecated As of JDK 1.1,
replaced by

* {@link
#setBounds(int,int,int,int)}

*/

3. java中如何自动生成注释

你说的应该是生成javadoc吧?

最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:

javadoc-ddocs-subpackagescom.yourpackage

其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.

JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:

用法:javadoc[options][packagenames][sourcefiles][@files]
-overview<file>从HTML文件读取概览文档
-public仅显示public类和成员
-protected显示protected/public类和成员(默认值)
-package显示package/protected/public类和成员
-private显示所有类和成员
-help显示命令行选项并退出
-doclet<class>通过替代doclet生成输出
-docletpath<path>指定查找doclet类文件的位置
-sourcepath<pathlist>指定查找源文件的位置
-classpath<pathlist>指定查找用户类文件的位置
-cp<pathlist>指定查找用户类文件的位置
-exclude<pkglist>指定要排除的程序包列表
-subpackages<subpkglist>指定要递归加载的子程序包
-breakiterator计算带有BreakIterator的第一个语句
-bootclasspath<pathlist>覆盖由引导类加载器所加载的
类文件的位置
-source<release>提供与指定发行版的源兼容性
-extdirs<dirlist>覆盖所安装扩展的位置
-verbose输出有关Javadoc正在执行的操作的信息
-locale<name>要使用的区域设置,例如en_US或en_US_WIN
-encoding<name>源文件编码名称
-quiet不显示状态消息
-J<flag>直接将<flag>传递到运行时系统
-X输出非标准选项的提要

通过标准doclet提供:
-d<directory>输出文件的目标目录
-use创建类和程序包用法页面
-version包含@version段
-author包含@author段
-docfilessubdirs递归复制文档文件子目录
-splitindex将索引分为每个字母对应一个文件
-windowtitle<text>文档的浏览器窗口标题
-doctitle<html-code>包含概览页面的标题
-header<html-code>包含每个页面的页眉文本
-footer<html-code>包含每个页面的页脚文本
-top<html-code>包含每个页面的顶部文本
-bottom<html-code>包含每个页面的底部文本
-link<url>创建指向位于<url>的javadoc输出的链接
-linkoffline<url><url2>利用位于<url2>的程序包列表链接至位于<url>的文档
-excludedocfilessubdir<name1>:..排除具有给定名称的所有文档文件子目录。
-group<name><p1>:<p2>..在概览页面中,将指定的程序包分组
-nocomment不生成说明和标记,只生成声明。
-nodeprecated不包含@deprecated信息
-noqualifier<name1>:<name2>:...输出中不包括指定限定符的列表。
-nosince不包含@since信息
-notimestamp不包含隐藏时间戳
-nodeprecatedlist不生成已过时的列表
-notree不生成类分层结构
-noindex不生成索引
-nohelp不生成帮助链接
-nonavbar不生成导航栏
-serialwarn生成有关@serial标记的警告
-tag<name>:<locations>:<header>指定单个参数定制标记
-taglet要注册的Taglet的全限定名称
-tagletpathTaglet的路径
-charset<charset>用于跨平台查看生成的文档的字符集。
-helpfile<file>包含帮助链接所链接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每个制表符占据的空格数
-keywords使程序包,类和成员信息附带HTML元标记
-stylesheetfile<path>用于更改生成文档的样式的文件
-docencoding<name>指定输出的字符编码

4. 如何写好java代码注释

写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。
这个时候，{@link}与@see，这2个javadoc注解就派上用场了，
不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。

@see 标签允许用户引用其他类的文档。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称

我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。
但是，{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果，看下面的图