滴水穿石-02制作说明文档

1 JDK的下载和安装

  1.1 可以从Oracle官网下载符合自己计算机的版本

    http://www.oracle.com/technetwork/cn/java/javase/downloads/jdk8-downloads-2133151-zhs.html

  1.2 安装(注意最好不要有中文或特殊字符)

 

2 配置环境变量

   2.1 path 作用:任意目录下都可以使用javac命令调用以EXE结尾的文件.

   2.2 方法:将jdk安装下的bin目录添加到最左边,并添加分号

    以我的安装目录为例       D:\Develop\Java\jdk1.8.0_152\bin

   这种方式一般不用,直接使用方式2:

   2.3 classPath文件的配置 作用:任意盘符下都可以运行.class文件

  配置方法,其实不配也行.我们运行的时候只要在.class盘符下运行即可,

 

3 通过notePad编辑

 

 

4 说明文档与文档注释 

/**
*操作数组工具类
* @author Aaron.yang
* @version V1.0
*/
public class ArrayTool{
    //构造方法
    private ArrayTool(){}
    /**
    * 遍历数组,遍历后的格式:[元素1,元素2,...]
    * @param  arr 这是要被遍历的数组
    */
    public static void printArray(int [] arr){
        System.out.print("[");
        for(int x=0;x<arr.length;a++){
            if(x==arr.length-1){
              System.out.print(arr[x] + "]");    
            }else{
             System.out.print(arr[x] + ",");
            }
        }
    }
    
    /**
    * 获取数组中最大值的方法
    * @param  arr 这是要获取最大值的数组
    * return 返回数组中的最大值
    */
    public static void getMax(int [] arr){
        int max = arr[0];
        for(int x=0;x<arr.length;a++){
            if(arr[x]>max){
             max = arr[x];    
            } 
        }
        return max;
    }
}
文档注释

 javadoc -d 目录 -author -version ArrayTool.java  (目录)表示输出目录

但是:以上的方法在实际运用中并不常用.哈哈哈哈,常用的是结合软件使用

 

5 讲HTML转化成chm

需要下载两个小工具

javadoc2chm.exe  http://jan.baresovi.cz/dr/en/en/javadoc-chm

Microsoft HTML HELP.exe       https://msdn.microsoft.com/en-us/library/ms669985.aspx

这种转换方法请参考网上其他教程.我这里使用的是通过Easy CHM 工具转换的

 

posted @ 2018-01-09 07:52  逍遥小天狼  阅读(187)  评论(0)    收藏  举报