java代码自动注释器 java自定义注释
java中如何自动生成注释
你说的应该是生成javadoc吧?
创新互联建站长期为上千家客户提供的网站建设服务,团队从业经验10年,关注不同地域、不同群体,并针对不同对象提供差异化的产品和服务;打造开放共赢平台,与合作伙伴共同营造健康的互联网生态环境。为和硕企业提供专业的成都网站设计、成都网站建设,和硕网站改版等技术服务。拥有十多年丰富建站经验和众多成功案例,为您定制开发。
最简单方式就是使用命令行, 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 指定输出的字符编码
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
这样,注释的//就会缩进了,而不是顶在行首了~
eclipse怎么设置创建一个java文件后自动加入注释
eclipse设置创建一个java文件后自动加入注释的方法:
1、通过菜单 Window-Preference 打开参数设置面板,然后选择:
Java - Code Style - Code Templates
2、在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:
3、进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。
4、最后,确保 Code - New Java files 中有:"${filecomment}"
如何在eclipse 中设置自动添加Javadoc注释
先看默认状态的吧,新建类文件时,是不生成注释的
在
windows--preferenceJava--Code Style--Code Templatescode--new Java file
编辑文件为7的样式,(为了方便起见,中间分布截图说明,熟悉的朋友直接跳到7)
对于中文版本
窗口--首选项
java--代码样式--代码模板
代码--新的java文件
菜单栏,窗口——首选项
找到java选项--代码样式
注释--新生成的java文件
直接编辑配置文件
在配置文件中间添加注释代码,这部分可以自定义,参考如下,关键字解释见后文10
------------------我是分割线,别复制我-----------------------------------
${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 创建时间:${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}
------------------我是分割线,别复制我-----------------------------------
现在新建文件将自动生成注释
补充说明;
也许你看到我们在写注释文件时用到了很多关键字,那么这里我们就了解一下Javadoc
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了
关键词列表:
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写
更多Javadoc用法可以访问:百度百科、官方文档。
网站标题:java代码自动注释器 java自定义注释
本文来源:http://scyanting.com/article/ddecpeh.html