Javadoc生成文档,包机制

Javadoc生成文档,包机制

Javadoc

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

参数信息

• @author 作者名
• @version 版本号
• @since 只需要最早使用的jdk版本
• @return 返回值情况
• @throws 异常抛出情况

package com.xjianbing.cnblogs.www;
/**
 * @author  xujb
 * @version 1.0  版本号
 * @since  1.6  jdk版本
 *
 * */
public class DocJava {
    String  a;
    /**
     *函数也能注释
     * @param a
     * @return
     * @throws Exception
     */
    public String   getTest(String a) throws Exception
    {
      return  a;

执行 javadoc命令编译 ：D:\相关笔记\java\相关笔记截图\JAVASE\基础语法\src\com\xjianbing\cnblogs\www>javadoc -encoding UTF-8 -charset UTF-8 DocJava.java

包机制

为了更好的组织类，java提供了包机制，用于区别类命名空间

包语句的语法格式为：

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

一般利用公司的域名倒置作为包名；

为了能够使用某一个包的成员，我们需要再JAVA程序中明确导入该包，使用import语句即可完成此功能，*表示导入所有

import  pkg1[.pkg2[.pkg3.....]].(classname|*)