java注释文档如何生成,java如何生成doc文档以及javadoc注释

1,java如何生成doc文档。

用eclipse内置的功能,右键项目-->export-->java-->javadoc-->javadoc command 选择jdk的bin目录的javadoc.exe,destination选择输入目录,点击finish即可。

2,注释注意事项

javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成

javadoc 标记有如下一些:

@author 标明开发该类模块的作者

@version 标明该类模块的版本

@see 参考转向,也就是相关主题

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

示例如下:

/**

* 解释器模式的表达式接口

* @author qiqi

* @version 1.2

*

*/

public interface Expression {

/**

* 解释方法

* @param c 上下文

* @return 整形

* @exception 不抛出异常

*/

public int interpreter(Context c);

}

图片是示例和doc文档,对比着看比较清晰明了。

0818b9ca8b590ca3270a3433284dd417.png

0818b9ca8b590ca3270a3433284dd417.png

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值