【JavaSE】05-Java包机制,JavaDoc生成文档

05-Java包机制,JavaDoc生成文档

①.包机制

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

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

一般利用公司域名作为倒置作为包名:com.ifinder.learn
导入包:为了能够使用一个包中的某一个成员,在程序中需要导入包
导入语法:

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

. *是通配符,可以用来导入一个包当中的所用东西。

②.JavaDoc

作用:javadoc是用来生成自己的API文档的
JDK8帮助文档网址:https://docs.oracle.com/javase/8/docs/api/

参数信息:

/**
*@author 作者名
*@version 版本号
*@since 指明需要最早使用的jdk版本
*@param 参数名
*@return 返回值情况
*@throws 异常抛出情况
*/

Doc窗口通过 javadoc [参数] xxx.java 可以生成javaDoc文档
IDEA生成JavaDoc文档方法:

  • 新建存放JavaDoc文件的文件夹
  • IDEA Tools选项卡→Generate JavaDoc…
  • 弹出界面的Output directory输入框中选择输出路径
  • 在Locale栏中配置语言编码集
    zh_CN代表中文
    -encoding utf-8 -charset utf-8
    可以让中文正常显示
  • 点击🆗,进入文件夹查看index.html文件,即是生成的JavaDoc文档
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值