java代码自动加注释,为什么要为程序添加注释?在JAVA程序中,如何添加注释?

如何在eclipse 中设置自动添加Javadoc注释

在eclipse 中设置自动添加Javadoc注释：

1、打来eclipse：首先打开eclipse，然后随意打开一个java类文件，最好找一个没有注释的类，方便实践一下；

2、打开perference：在已经打来的eclipse中，点击顶部工具栏中的window目录下的perference按钮，进入perference窗体；

3、找到Code Templates：在perference窗体的左边栏中，输入Code Templates ,按回车键回车，就能快速定位到Code Templates；

4、设置风格和进行勾选：

在Code Template 中找到comment目录，该目录下就是有关注释的相关代码风格设置，这里有各种类型，字段，类型，构造方法以及继承的方法，这里面已经是系统默认的注释，可以点击edit按钮自行定义，现在重要的是点击下面的勾选按钮进行勾选，然后保存设置；

5、选中方法体测试：

在eclipse代码编辑区域，选中一方法，该方法实现了某接口定义的方法，像图中所示选中它，按快捷键Shift+Alt+J;

6、查看效果：

经过上面的快捷键操作，就能看到，Javadoc注释的代码已经自动添加到编辑方法体上面，方便我们以后开发的阅读，提高效率。

相关问答

Q1: 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                           不显示状态消息

  -Jflag                         直接将 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              指定输出的字符编码

Q2: java开发时怎么自动添加注解

想要自动添加注释，首先需要对eclipse进行一些设置。

打开Eclipse,然后点击-windows-preferences-Java-code styles-code templates-comments-types-点击右侧的edit进行编辑，在打开的编辑窗口中修改下面的文字

/**

* @author ${user}

*

* ${tags}

*/

替换成

/**

* @author 你的名字

*

* ${tags}

*/

上面的操作对应的图片是这样的:

这样作者就修改成你的名字了，更多的信息可以点击本编辑窗口上面的insert varibles按钮，会弹出一些文件名称，项目名称等参数，你可以选择性地添加到你的注视中。

然后在你的类中，你只要敲入/**然后换行，注释就自动滴添加到你的代码中了~希望能帮上你的忙~^_^

追问：

这只是文档前的版权声明注释，如果要在文档中对代码添加注释，里面带上修改时间，如何弄

回答：

这样弄哈~

1.开始还是打开Eclipse,然后点击-windows-preferences-Java-code styles-code templates-comments

2.下一步选择methods，而不是types。然后edit，insert varibles，添加上date变量，长下面这个样子。

然后你在你的函数上面同样是敲入/**回车，就出现了修改的日期了

补充：

对于那个行首出现注释的问题是java的代码风格的问题，可以这样改

打开Eclipse,然后点击-windows-preferences-Java-code styles-formatter

-edit-comment 的标签页-never indent line comments on first column

这样，注释的//就会缩进了，而不是顶在行首了~