Java包机制及javadoc详解

包机制

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

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

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

  • 例如 www.baidu.com
  • 包为 com.baidu.www
  • 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用"import"语句可完成此功能。
import package1[.package2...].(classname|*);
  • 导入的包中导入*(通配符)表示导入该包下面所有的东西

JavaDoc

  • javadoc命令是用来生成自己API文档的
  • 参数信息
    • @author 作者名
    • @version 版本号
    • @since 指明需要最早使用的jdk版本
    • @param 参数名
    • @return 返回值情况
    • @throws 异常抛出情况
  • 在包名的下面做好版本注释等
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */

然后使用javadoc进行文档生成(cmd中),如果java文件中出现了中文,最好加上编码设定

javadoc -encoding UTF-8 -charset UTF-8 xxx.java

Java包机制及javadoc详解_第1张图片

则会生成一系列文档

到此这篇关于Java包机制以及javadoc的文章就介绍到这了,更多相关Java包机制内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

你可能感兴趣的:(Java包机制及javadoc详解)