JAVA基础:包机制、JavaDoc及JavaDoc的生成 你一定行的!冲冲冲

包机制

为了更好地组织类,Java提供了包机制,用于区别别类名的命名空间。

包的本质就是文件夹

  • 包语句的语法格式为:

    package pkg1[.pkg2[.pkg3...]];
    
  • 一般利用公司域名倒置作为包名

    www.baidu.com -->com.baidu.www

  • 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用“import”语句可完成此功能

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

JavaDoc

参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
  • 在这里插入图片描述

/**
 * @author 13754
 * @version 1.0
 * @since 1.8
 */
public class Demo05 {
    String name;

    /**
     * @author 13754
     * @param name
     * @return
     * @throws Exception
     */
   public String test(String name) throws Exception{
       return name;
   }
    //命令行:javadoc 参数 java文件

}

Javadoc命令格式如下:
javadoc [选项] [软件包名称] [源文件]

执行的命令

-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员(默认)
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <类> 通过替代 doclet 生成输出
-docletpath <路径> 指定查找 doclet 类文件的位置
-sourcepath <路径列表> 指定查找源文件的位置
-classpath <路径列表> 指定查找用户类文件的位置
-exclude <软件包列表> 指定要排除的软件包的列表
-subpackages <子软件包列表> 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
-source <版本> 提供与指定版本的源兼容性
-extdirs <目录列表> 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale <名称> 要使用的语言环境,例如 en_US 或 en_US_WIN
-encoding <名称> 源文件编码名称
-quiet 不显示状态消息

生成Doc文档方法:

打开方式一:

在文件所在位置打开命令栏(cmd)
输入:javadoc -encoding UTF-8 -charset UTF-8 加上XX.java

打开方式二:
IDEA内打开—>tool—>Generate JavaDoc如图:
在这里插入图片描述
在Other command line argumens那一栏写:
-encoding UTF-8 -charset UTF-8 -windowtitle “Doc” -link http://docs.Oracle.com/javase/8/docs/api
打开Doc文档所在文件夹,找到以java文件命名的html文档,打开就是了。

-encoding UTF-8 -charset UTF-8这个防止乱码

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

二毛就不是钱吗

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值