「javasee用法」Javase

今天给各位分享javasee用法的知识，其中也会对Javase进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、javadoc中的@see超链接怎么做呀？我在注释里写了@see+类名，但是生成的html文档里，类名没有生成超链接！
• 2、Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等
• 3、如何写好java代码注释

javadoc中的@see超链接怎么做呀？我在注释里写了@see+类名，但是生成的html文档里，类名没有生成超链接！

使用java是无法自动生成注释的。最多生成注释的空壳。例如在eclipse可以用alt-shift-j，生成一个空的注释框架。 具体的内容还是需要开发者自己来实现的。现在代码还没有灵活到通过看你的代码了解你要做什么。

另外一种生成注释的方法则是反过来，自动生成代码的同时自动生成注释。一般使用伪代码工具来编写，然后在生成代码的同时生成java。这样的工具不多。而且往往有很大的局限。往往属于公司内部使用的工具。

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

常用Java注释标签（Java comment

tags）

@author 作者

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

（*多个作者使用多个@author标签标识，java

doc中显示按输入时间顺序罗列。）

例：*

@author Leo. Yao

@param 输入参数的名称 说明

适用范围：方法

例：* @param str

the String用来存放输出信息。

@return 输出参数说明

适用范围：方法

例： *

@return codetrue/code执行成功;

* codefalse/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)}

*/

如何写好java代码注释

写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。

这个时候，{@link}与@see，这2个javadoc注解就派上用场了，

不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。

@see 标签允许用户引用其他类的文档。具体使用方式如下：

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名称

@see fully-qualified-classname#属性名称

我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。

但是，{@link}这个却可以随便放。

具体使用方法和上面那个@see是一样的。

实际效果，看下面的图

javasee用法的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于Javase、javasee用法的信息别忘了在本站进行查找喔。