在eclipse 中设置自动添加Javadoc注释:
①.、打来eclipse:首先打开eclipse,然后随意打开一个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??????创建类和程序包用法页面
-splitindex????将索引分为每个字母对应一个文件
-windowtitle?text???文档的浏览器窗口标题
-doctitle?html-code??包含概览页面的标题
-header?html-code???包含每个页面的页眉文本
-footer?html-code???包含每个页面的页脚文本
-top?html-code???包含每个页面的顶部文本
-bottom?html-code???包含每个页面的底部文本
-link?url????创建指向位于?url?的?javadoc?输出的链接
-excludedocfilessubdir?name1:..?排除具有给定名称的所有文档文件子目录.
-nocomment?????不生成说明和标记,?只生成声明.
-nodeprecatedlist???不生成已过时的列表
-notree?????不生成类分层结构
-noindex?????不生成索引
-nohelp?????不生成帮助链接
-nonavbar????不生成导航栏
-tag?name:locations:header?指定单个参数定制标记
-taglet?????要注册的?Taglet?的全限定名称
-tagletpath????Taglet?的路径
-charset?charset???用于跨平台查看生成的文档的字符集.
-helpfile?file????包含帮助链接所链接到的文件
-linksource????以?HTML?格式生成源文件
-sourcetab?tab?length??指定源中每个制表符占据的空格数
-keywords????使程序包,?类和成员信息附带?HTML?元标记
-stylesheetfile?path???用于更改生成文档的样式的文件
-docencoding?name???指定输出的字符编码
想要自动添加注释,首先需要对eclipse进行一些设置.
/**
* @author ${user}
*
* ${tags}
*/
替换成
* @author 你的名字
上面的操作对应的图片是这样的:
然后在你的类中,你只要敲入/**然后换行,注释就自动滴添加到你的代码中了~希望能帮上你的忙~^_^
追问:
这只是文档前的版权声明注释,如果要在文档中对代码添加注释,里面带上修改时间,如何弄
回答:
这样弄哈~
然后你在你的函数上面同样是敲入/**回车,就出现了修改的日期了
补充:
对于那个行首出现注释的问题是java的代码风格的问题,可以这样改
-edit-comment 的标签页-never indent line comments on first column
这样,注释的//就会缩进了,而不是顶在行首了~
以上就是土嘎嘎小编为大家整理的java代码自动加注释相关主题介绍,如果您觉得小编更新的文章只要能对粉丝们有用,就是我们最大的鼓励和动力,不要忘记讲本站分享给您身边的朋友哦!!