JavaDoc及生成index.html

package com.kuang.base;

/**                             加在类上,就是类的注释
 * @author kuangshen
 * @version
 * @since 1.8
 */



public class Doc {
    String name;  //顶一个变量,在类里面定一个变量,类变量 ,此行作为一个属性,和下面两个并列

    /**                             加在方法上,就是方法的注释
     * @author kuangshen
     * @param name
     * @return
     * @throws Exception
     */




    public String test(String name) throws Exception{  //此行和下行为方法,其中String name为参数
        return name;
    }
}

/*
生产JavaDoc文档
1.通过命令行  JavaDoc 参数 Java文件  实现
2.使用IDEA实现JavaDoc文件    Tool>Generate JavaDoc>选定生成后的文件夹1,语言(中文为zh_CN)2,以及避免乱码3
 -encoding UTF-8 -charset UTF-8 -windowtitle “poi导出配置” -link http://docs.Oracle.com/javase/7/docs/api
 */

//基础部分的一切知识,后面几乎每天都会用
//JDK8 英文   API帮助文档

 

posted @ 2021-10-21 21:01  荡漾1122  阅读(254)  评论(0)    收藏  举报