eclipse怎么写文档注释( 二 )


望 。然而,所有类注释都会包含到输出结果里 。
上述代码的输出是一个 HTML 文件,它与其他Java 文档具有相同的标准格式 。因此,用户会非常熟悉这种格
式,可在您设计的类中方便地“漫游” 。设计程序时,请务必考虑输入上述代码,用 javadoc 处理一下,观
看最终 HTML 文件的效果如何 。
4.如何写Java文档注释1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级 。
如果单行无法完成,则应采用块注释 。注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释 。
主要为了使该行代码失去意义 。注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释 。
一般与代码行后空8(至少4)个格,所有注释必须对齐 。注释格式:代码 + 8(至少4)个空格 + // 注释内容 2、块(block)--块注释:/*……*/ 注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述 。
一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置 。这种域注释不会出现在HTML报告中 。
注释格式通常写成: /* * 注释内容 */ 3、文档注释:/**……*/ 注释若干行,并写入javadoc文档 。每个文档注释都会被置于注释定界符 /** 。
*/。
5.怎么在eclipse添加固定注释分两种情况的:
如果是javadoc的注释:可以通过 alt+shift+ j
如果是 lisence:可以同个 code template实现
自定义注释风格
Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> CodeTemplates
可以看到Comments下面一系列可以注释的Java代码组成部分(对文件、变量、方法、构造方法、重载函数等等),比如我想定制Java文件的注释风格,那么在右侧选择Comments中的File项,点击Edit,进入编辑模式,这样就可以自定义注释了 。其中可以插入一些变量,如日期、文件名、作者等等 。
6.eclipse怎么自动生成注释Window-注释的元素 。
现就每一个元素逐一介绍:文件(Files)注释标签:/** * Copyright ? ${year}公司名字. All rights reserved. * * @Title: ${file_name} * @Prject: ${project_name} * @Package: ${package_name} * @Description: ${todo} * @author: ${user} * @date: ${date} ${time} * @version: V1.0 */ 类型(Types)注释标签(类的注释):/** * @ClassName: ${type_name} * @Description: ${todo} * @author: ${user} * @date: ${date} ${time} * ${tags} */ 字段(Fields)注释标签:/** * @fieldName: ${field} * @fieldType: ${field_type} * @Description: ${todo} */ 构造函数标签:/** * @Title:${enclosing_type} * @Description:${todo} * ${tags} */ 方法(Constructor & Methods)标签:/** * @Title: ${enclosing_method} * @Description: ${todo} * ${tags} * @return: ${return_type} */ 覆盖方法(Overriding Methods)标签:/* (non Javadoc) * @Title: ${enclosing_method} * @Description: ${todo} * ${tags} * ${see_to_overridden} */ 代表方法(Delegate Methods)标签:/** * ${tags} * ${see_to_target} */ getter方法标签:/** * @return the ${bare_field_name} */ setter方法标签:/** * @param ${param} the ${bare_field_name} to set */ 或者可以从网上下载配置好的.xml文件导入也可以 。下载请点击我! PS:在按照上面的方法设置后,一定要到windows->Preferences->general->Content Types,右侧Context Types树,点开Text,选择Java Source File,在下面的Default encoding输入框中输入UTF-8,点Update,则设置Java文件编码为UTF-8,否则会出现字符编码的问题 。
经过如上的设置后,就可以使用快捷键Alt+Shift+J来快速生成文档的注释了 。使用方法如下:文件头注释:使用New->Class方法生成的文件会在创建类的对话框选项中提示是否生成注释,默认是选中的 。