包机制,JavaDoc

包机制

  • 一般利用公司域名倒置作为包名;con.baidu.www
  • java程序使用"import"语句导入包
package com.le.base;
import java.util.Date;

JavaDoc

  1. @author
  2. @version
  3. @since 指明需要使用的JDK版本
  4. @param 参数名
  5. @return
  6. @throws
package com.le.base;

/**
 * @author le
 * @version 1.0
 * @since 1.8
 */
public class doc {
    String name;

    /**
     * @author le
     * @version 1.0
     * @since 1.8
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

** 生成帮助文档 **

  • 在命令行文件位置:G:\java\study_code\src\com\le\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
  • 在IDEA生成: 在IDEA中选择工具(Tool)选项卡打开
上一篇:JavaDoc生成文档


下一篇:java的三种注释区别