java中如何自动生成注释

你说的应该是生成javadoc吧?

最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:

javadoc -d docs -subpackages com.yourpackage

其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.

JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

  -overview <file>                 从 HTML 文件读取概览文档

  -public                          仅显示 public 类和成员

  -protected                       显示 protected/public 类和成员 (默认值)

  -package                         显示 package/protected/public 类和成员

  -private                         显示所有类和成员

  -help                            显示命令行选项并退出

  -doclet <class>                  通过替代 doclet 生成输出

  -docletpath <path>               指定查找 doclet 类文件的位置

  -sourcepath <pathlist>           指定查找源文件的位置

  -classpath <pathlist>            指定查找用户类文件的位置

  -cp <pathlist>                   指定查找用户类文件的位置

  -exclude <pkglist>               指定要排除的程序包列表

  -subpackages <subpkglist>        指定要递归加载的子程序包

  -breakiterator                   计算带有 BreakIterator 的第一个语句

  -bootclasspath <pathlist>        覆盖由引导类加载器所加载的

                                   类文件的位置

  -source <release>                提供与指定发行版的源兼容性

  -extdirs <dirlist>               覆盖所安装扩展的位置

  -verbose                         输出有关 Javadoc 正在执行的 *** 作的信息

  -locale <name>                   要使用的区域设置, 例如 en_US 或 en_US_WIN

  -encoding <name>                 源文件编码名称

  -quiet                           不显示状态消息

  -J<flag>                         直接将 <flag> 传递到运行时系统

  -X                               输出非标准选项的提要

通过标准 doclet 提供:

  -d <directory>                   输出文件的目标目录

  -use                             创建类和程序包用法页面

  -version                         包含 @version 段

  -author                          包含 @author 段

  -docfilessubdirs                 递归复制文档文件子目录

  -splitindex                      将索引分为每个字母对应一个文件

  -windowtitle <text>              文档的浏览器窗口标题

  -doctitle <html-code>            包含概览页面的标题

  -header <html-code>              包含每个页面的页眉文本

  -footer <html-code>              包含每个页面的页脚文本

  -top    <html-code>              包含每个页面的顶部文本

  -bottom <html-code>              包含每个页面的底部文本

  -link <url>                      创建指向位于 <url> 的 javadoc 输出的链接

  -linkoffline <url> <url2>        利用位于 <url2> 的程序包列表链接至位于 <url> 的文档

  -excludedocfilessubdir <name1>:.. 排除具有给定名称的所有文档文件子目录。

  -group <name> <p1>:<p2>..        在概览页面中, 将指定的程序包分组

  -nocomment                       不生成说明和标记, 只生成声明。

  -nodeprecated                    不包含 @deprecated 信息

  -noqualifier <name1>:<name2>:... 输出中不包括指定限定符的列表。

  -nosince                         不包含 @since 信息

  -notimestamp                     不包含隐藏时间戳

  -nodeprecatedlist                不生成已过时的列表

  -notree                          不生成类分层结构

  -noindex                         不生成索引

  -nohelp                          不生成帮助链接

  -nonavbar                        不生成导航栏

  -serialwarn                      生成有关 @serial 标记的警告

  -tag <name>:<locations>:<header> 指定单个参数定制标记

  -taglet                          要注册的 Taglet 的全限定名称

  -tagletpath                      Taglet 的路径

  -charset <charset>               用于跨平台查看生成的文档的字符集。

  -helpfile <file>                 包含帮助链接所链接到的文件

  -linksource                      以 HTML 格式生成源文件

  -sourcetab <tab length>          指定源中每个制表符占据的空格数

  -keywords                        使程序包, 类和成员信息附带 HTML 元标记

  -stylesheetfile <path>           用于更改生成文档的样式的文件

  -docencoding <name>              指定输出的字符编码

如何写Java文档注释(Java Doc Comments)

本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西

本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释

业余时间整理，难免有遗漏或错误，如有发现欢迎指正

转载地址：网页链接

文档注释概览

“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。

文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。

比如：

/**这是文档注释*/

/* 这是一般注释*/

// 这是一般注释

在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。

此外，文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。

文档注释采用HTML语法规则书写，支持HTML标记(tag)，同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了javadoc工具更好地生成最终文档。所以，虽然有些标记写起来麻烦且看着不直观，还是要老老实实按规矩写滴。

原文地址：网页链接

使用Java反编译工具。

jar包反编译后没有注释可以使用Java反编译工具，将jar包反编译成Java源代码，然后手动添加注释。

Jar包是Java语言中的一种文件格式，它通过将多个Java类文件及其依赖项打包成单个文件来简化Java应用程序的分发和部署。

---