java文档注释和相对路径

1 文档注释

1.1 基本格式

/** * @author lgs * @version 1.0 */

1.2 如何生成对应的文档注释

javadoc -d 生成到目标文件夹名 -xx -yy 注释所在Java文件

-xx
-yy 文档使用了哪些标签

例如：javadoc -d d:\\ -author -version Comment02.java

 

1.3 常用标签

 

 

 

@author 作者标识 包、 类、接口
@deprecated 标识当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API 包、类、接口、值域、构造函数、 方法
{@docRoot} 指明当前文档根目录的路径
@exception 标志一个类抛出的异常 构造函数、 方法
{@inheritDoc} 从直接父类继承的注释
{@link} 链接到某个特定的成员对应的文档中 包、类、接口、值域、构造函数、 方法
{@linkplain} 插入一个到另一个主题的链接，但是该链接显示纯文本字体 包、类、接口、值域、构造函数、 方法
@param 方法的入参名及描述信息，如入参有特别要求，可在此注释 构造函数、方法
@return 对函数返回值的注释 方法
@see 引用,查看相关内容，如类、方法、变量等 包、类、接口、值域、构造函数、 方法
@serial 说明一个序列化属性
@serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据
@serialField 说明一个ObjectStreamField组件 @
@since 描述文本,API在什么程序的什么版本后开发支持 包、类、接口、值域、构造函数、 方法
@throws 构造函数或方法所会抛出的异常 构造函数、 方法
{@value} 显示常量的值，该常量必须是static属性 静态值域
@version 版本号 包、 类、接口

 

2 相对路径

相对路径：从当前目录开始定位，形成的一个路径
绝对路径：从根目录开始定位，形成的一个路径

如：

D:
--abc文件夹
--test100文件夹
--test200文件夹
---abc2目录
--test100文件夹
--test200文件夹
--hello.txt

当前目录：D:/abc/test100
需求1.从abc/test100访问abc2/test200/hello.txt目录
相对路径：..\..\abc2\tet200\hello.txt
绝对路径：D:\abc2\test200\hello.txt