zoukankan      html  css  js  c++  java
  • 帮助文档的制作javadoc

    将自己写的工具类ToolTool.class文件发送给其他人,其他人只要将该文件设置到classpath路径下,就可以使用该工具类。

    但是很遗憾,该类中到底定义了多少个方法,对方却不清楚,因为该类并没有使用说明书。

    开始制作程序的说明书,Java的说明书通过文档注释来完成。

    /**

    .............

    @ author joan

    @ version v1.1

    */

    /**

    @ param arr 数组

    @ return ............

    */

    用类似这样的格式来给Java文件注释。

    Javac -d myhelp -author -version javac Tool.java

    1.需要bin目录下的javadoc.exe工具,对该文档进行提取并形成说明书。

    2.这里我们把建好的Tool.java放到D盘的java目录下。

    3.----->cmd----->javac----->D:------>cd java------>javac Tool.java 

      进入D盘的java目录下,编译Tool.class文件。

    4.javadoc -d myhelp -author -version javac Tool.java

      对该文档进去提取并形成说明书。

      在Djava目录下,生成文件名为myhelp的说明书,可以显示版本、作者。

      -d  --->就是在dir路径

      -dc  ---->也可以指定说明书生成的位置,例如,在C盘。

    5.发给其他人用是,就只要有Tool.class和说明书就可以了,给Tool.class配置环境变量。

  • 相关阅读:
    ABP dynamic API
    SQL语句 还原未知逻辑名称数据库
    SQL 还原数据库
    使用开源项目集锦
    webp性能测评
    js通过继承实现私有函数
    js组合继承和寄生组合式继承比较
    JS中循环绑定遇到的问题及解决方法
    JS学习之事件流
    OpenGL利用模板测试实现不规则裁剪
  • 原文地址:https://www.cnblogs.com/Joanna-Yan/p/4596515.html
Copyright © 2011-2022 走看看