包机制与JavaDoc

包机制

1. 包的本质，就是文件夹

2. 包名规范：

   • 一般利用公司域名倒置作为包名：www.baidu.com ------> "com.baidu.www"；eg：com.wu

   • eg:实验新建包：com.baidu.www,产生三个递包com-->baidu-->www（产生包显示单层包，在project的设置中取消Hide Empty Middle Package * or 取消Compact Middle Package）

   • 包类似于c语言的头文字文件，一些命令需要先声明包才能用

   • 定义包：package pkg1.pkg2.pkg3......；

   • 导入包：import package1.package2.package3.......;(不要让在定义包时导入该包；类似于c语言函数定义时不能嵌套它自己？)

   • '*':导入该包下所有的类

 

JavaDoc

1. 生成自己的API文件

2. 参数信息

   • @authoe作者名

   • @version定义的版本号

   • @since指名需求最低的版本号

   • @param参数名

   • @return返回值情况

   • @throws异常抛出值情况

   • 第一种在类中用’/**‘加Enter

   • eg:/**
       * @quthor wu
       * @version 1.0
       * @...
       */
     ​
       public class Doc {..................

   • 第二种用方法

   • public class Doc {
     ​
         String name;
     ​
         /**
          * @author wu
          * @param name
          * @return
          * @throws Exception
          */
     ​
         public String test(String name) throws Exception{
             return name;
         }

   • 找到Doc的位置用cmd命令打开：javadoc -encoding UTF-8 -charset UTF-8 Doc.java 会生成index.html   即生成的文档首页