包机制+JavaDoc

包机制

为了更好地组织类，Java提供了包机制，用于区别类名的命名空间。包语句的语法格式为:

 package pkg1[. pkg2[. pkg3...]];

一般利用公司域名倒置作为包名; 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用"import”语句可完成此功能

 import package1[.package2...].(classname|*);

Java.Doc

在线的API帮助文档：点击跳转

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

参数信息

@author作者名

@version版本号

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

@param参数名

@return返回值情况

@throws异常抛出情况

 package com.kang.base;
 ​
 /**
  * @author wang
  * @version 1.0
  * @since 1.8
  */
 public class Doc {
     String name;
 ​
     /**
      * @author wang
      * @param name
      * @return
      * @throws Exception
      */
     public String test(String name) throws Exception{
         return name;
     }
 ​
     //狂神通过命令行
 ​
     //我们面向百度用IDEA生产JavaDoc文档   
     //基础部分的一切知识，后边每天几乎都会用
 }

用IDEA生成JavaDoc文档，点击跳转