您的位置:

java开发注释模板导入(java注释模板设置)

本文目录一览:

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

如何新建个java文件自动添加注释

eclipse的话可以添加修改注释模板,生成的文件就自动有了,一些类,方法可以快捷键生成

java的javadoc怎么用?

Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。

JBuilder提供了多项对Javadoc支持的功能,可以通过向导在工程窗格的树中创建Javadoc的节点,通过节点的菜单命名创建工程的Javadoc文档,可以通过诱导的方式录入Javadoc的标签,检验注释是否和源代码相匹配等。

本文,我们将讲解如何在源代码中用Javadoc标签写注释及如何创建Javadoc文档。

虽然软件工程中把详细设计作为软件项目的一个重要的阶段,但在实践中往往没有得到落实。并不是这个阶段不重要,而是实施有很大的困难,因为软件需求是天生的易动症患者,好不容易详细设计出来后,需求已和当初的版本大相径庭,而花费巨大,精雕细琢的详细设计已变成昨日黄花了。

Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。

可以通过代码模板快速的录入Javadoc注释,你也可以选择通过Javadoc对话框以一种形象化的方式录入Javadoc注释。此外,JBuilder还提供了各种Javadoc的辅助功能,如JavadocInsight诱导录入,冲突报告和更正,特殊的todo标签等。

虽然在Java文件中编写注释后,马上可以切换到内容窗格的Doc视图页代码中对应的Javadoc文档,但在Doc视图页中生成的文档仅是不完整的"范本"。首先,没有导航树,其次没有生成通过@see或@link关联内容的链接。所以你可以把Doc视图页中的Javadoc文档看成是Javadoc最终版本的预览。

本文中我们介绍了Javadoc的标签,讲解了如何在JBuilder编辑Javadoc注释,你应该尽量使用JavadocInsight、ClassInsight和ParameterInsight快速而正确地编写Javadoc注释。此外你应该将常用的注释做成模板,方便快速录入。

JBuilder提供的注释冲突报告和恢复的功能可以使你轻松解决注释冲突的问题,免除了单调的手工调整操作。

JBuilder还允许你自定义Javadoc标签,以满足一些个性化的要求。此外JBuilder自定义的todo标签可以使你随时随地在需要的地方作上标记,不至于遗漏未尽的工作。

idea 如何导入java注释模板文件

可以了解下idea的livetemplate,非常强大,idea可以将整个IDE的配置都导出来,然后导入

如何在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用法可以访问:百度百科、官方文档。

eclipse怎么设置创建一个java文件后自动加入注释

eclipse设置创建一个java文件后自动加入注释的方法:

1、通过菜单 Window-Preference 打开参数设置面板,然后选择:

Java - Code Style - Code  Templates

2、在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:   

3、进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。

4、最后,确保 Code - New Java files 中有:"${filecomment}"