zoukankan      html  css  js  c++  java
  • 5,帮助文档(说明文档/API文档)的制作

    API文档:应用程序接口

    对多个程序都会使用到 的方法进行封装,封装成工具类

    对工具类中的函数都封装成public(方便其他项目的使用),static(不用创建对象,直接使用类名调用)。

    对构造函数,标记为private类型(禁止用户创建工具类的实例)

    如果不声明构造函数,系统会自动添加一个构造函数,且自动添加的构造函数的权限与类的访问控制权限相同。

    下面是封装过程

    S1:对类的注释

    文档注释工具可以识别,并提取一些特殊的标识

    @author 表示作者

    @version 表示版本

    /**
    该类是对数组的操作的工具类,该类提供对数组的获取最值,排序等功能,
    @author sy
    @version 1.1
    */
    public class ArrayTool{
    
    }

    S2:对方法注释

    凡是public修饰符修饰的都用文档注释符注释,以便被工具使用

       /**
        获取数组的最大值
        @param  arr 整型的数组参数
        @return 返回数组中的最大值
        */
        public static int getMax(int[] arr)
        {
            return 1;
        }

    S3:编译源文件

    javac ArrayTool.java

    S4:生成文档

    javadoc -d doc ArrayTool.java

    doc 为生成文档的目录(如果该目录存在,就直接使用,不存在,会先创建在使用)

    ArrayTool.java 一定不要落下.java

    -author:提取作者信息

    -version:提取版本信息

    s5:生成的文档

    双打开索引文件即可(index.html)

    注意事项:

    类的访问权限必须是public

    只有public protected类型的方法会被提取

  • 相关阅读:
    帝国CMS采集
    帝国CMS常用资料
    IIS 支持PHP(与Apache环境共存)
    Firebug+Firefox 脚本调试
    javascript 参考
    [__NSCFString objectFromJSONString]: unrecognized selector sent to 解决办法
    大家好,我在CSDN开通了博客
    Apple MachO Linker Error
    ios 排序
    ios 二维码生成 扫瞄
  • 原文地址:https://www.cnblogs.com/exexex/p/8384994.html
Copyright © 2011-2022 走看看