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文档,对比着看比较清晰明了。

©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页