首页 > 编程语言 >Java包机制以及javadoc

Java包机制以及javadoc

时间:2022-10-14 10:14:52浏览次数:47  
标签:baidu 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
        
      • image

      • 则会生成一系列文档

标签:baidu,Java,javadoc,导入,文档,机制
From: https://www.cnblogs.com/xy-tobby/p/16790668.html

相关文章