首页 > 技术文章 > 包机制,JavaDoc生成文档

qqyzml 2021-02-03 21:09 原文

包机制,JavaDoc生成文档

包机制

  • 包机制的语法格式为:package pkgq[. pkg2[. pkg3...]];

  • 一般利用公司域名倒置作为句名:eg:com.zhang.xxx

  • 导入包用import语句:import package1[. package2...].(classname|*);

 import com.xue.base.*;
 .*代表导入这个包下所有的类

JavaDoc生成文档

  • javadoc命令是用来生成自己的API文档的

  • 参数信息

    • @author 作者名

    • @version 版本号

    • @since 指明需要最早使用的jdk版本

    • @param 参数名

    • @return 返回值情况

    • @throws 异常抛出情况

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

Doc

 

推荐阅读