包机制、JavaDoc生成文档

包

本质：一个文件夹
用处：用于区别类名的命名空间
一般利用公司的域名倒置作为包名；com.baidu.www
为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用import 语句

javaAPI帮助文档
Overview (Java Platform SE 8 )

JDK21帮助文档链接
Overview (Java SE 21 & JDK 21)

JavaDoc

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

参数信息

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

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

encoding 编码
charset 字符集编码

正在加载源文件Doc.java...
正在构造 Javadoc 信息...
正在构建所有程序包和类的索引...
标准 Doclet 版本 21.0.11+9-LTS-211
正在构建所有程序包和类的树...
Doc.java:4: 警告: 无主说明
 * @author flower
   ^
正在生成.\com\flower\base\Doc.html...
Doc.java:13: 警告: 无主说明
     * @param name
       ^
Doc.java:13: 警告: @param 没有说明
     * @param name
       ^
Doc.java:14: 警告: @return 没有说明
     * @return
       ^
Doc.java:15: 警告: @throws 没有说明
     * @throws Exception
       ^
Doc.java:8: 警告: 使用不提供注释的默认构造器
public class Doc {
       ^
正在生成.\com\flower\base\package-summary.html...
正在生成.\com\flower\base\package-tree.html...
正在生成.\overview-tree.html...
正在构建所有类的索引...
正在生成.\allclasses-index.html...
正在生成.\allpackages-index.html...
正在生成.\index-all.html...
正在生成.\search.html...
正在生成.\index.html...
正在生成.\help-doc.html...
6 个警告

IDEA内生成javadoc方法