javadoc(1)

javadoc

包机制

本质就是文件夹,一般命名为域名的倒置,如com.baidu.www,个人可命名为,com.chunsui.XXX。
需要注意的是,jdk一般默认为隐藏空包,需要在Project上右键找到Tree Appearance ->compact Middle Packadges取消勾选。

引入

在包下可利用import引入一些方法,可在浏览器搜索到jdk在线帮助文档。
需要了解的是,*表示通配符,可引入该包内的所有方法。

导出帮助文档

生成API

/**
  @autor 作者名
  @version 版本号
  @since jdk版本
*/
**另外在类/方法之前输入/**并回车可得到类/方法的一些参数信息。**

导出文档

  在需要生成文档的目录下调出命令提示符(方法可见之前的随笔),然后输入javadoc -encoding UTF-8 -charset UTF-8 类名.java,即可。
  生成的文档位于当前目录下,找到index.html文件打开即可看到。
posted @ 2022-07-01 13:33  椿岁  阅读(26)  评论(0)    收藏  举报