使用javadoc生成api文档(一):注释及标记

注释及标记

一:常用注释

//单行注释; ---->一般用于描述单行的信息

/**

*/多行注释;---->一般用户描述类或方法

二:嵌入HTML

注释中嵌入HTML为了使后面生成api更加美观。在/**与*/中间可以根据HTML语言任意设计api界面。以描述代码片段的信息。

/**
 * <p>
 * System.out.println(new Date()); 
 * </p>
 * <li></li>
 */

三:引用其他类

@see所有文档类型都可以包含此标记,他允许我们引用其他类里的文档,对于这个标记javadoc会生成响应的HTML,将其连接到其他文档。

@see 类名

@see 完整类名

@sess完整类名#方法名

四:类文档标记

1.@version 版本信息;若在javadoc中使用了“-version”标记,就会生成HTML文档里提取出的版本信息。

2.@author 作者信息;若在javadoc中使用了“-author”标记,就会生成HTML文档里提取出的作者信息。

五:变量文档标记

变量文档只能包括HTML以及@see引用

  1. 方法文档标记

1.@param 参数名

2.@return 返回值的含义

3.@exception 异常

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值