eclipse怎么写文档注释

1.eclipse怎么生成注释文档

/步骤

先看默认状态的吧，新建类文件时，是不生成注释的

在

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}

现在新建文件将自动生成注释

2.如何写Java文档注释

如何写Java文档注释（Java Doc Comments）

本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西

本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释

业余时间整理，难免有遗漏或错误，如有发现欢迎指正

转载地址：网页链接

文档注释概览

“文档注释”（Java Doc Comments）是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。

文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。

比如：

/**这是文档注释*/

/* 这是一般注释*/

// 这是一般注释

在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。

此外，文档注释只负责描述类（class）、接口（interface）、方法（method）、构造器（constructor）、成员字段（field）。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。

文档注释采用HTML语法规则书写，支持HTML标记（tag），同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了javadoc工具更好地生成最终文档。所以，虽然有些标记写起来麻烦且看着不直观，还是要老老实实按规矩写滴。

原文地址：网页链接

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

所有javadoc 命令都只能出现于“/**”注释中。但和平常一样，注释结束于一个“*/”。主要通过两种方式

来使用 javadoc：嵌入的HTML，或使用“文档标记”。其中，“文档标记”（Doc tags）是一些以“@”开头

的命令，置于注释行的起始处（但前导的“*”会被忽略）。

有三种类型的注释文档，它们对应于位于注释后面的元素：类、变量或者方法。也就是说，一个类注释正好

位于一个类定义之前；变量注释正好位于变量定义之前；而一个方法定义正好位于一个方法定义的前面。如

下面这个简单的例子所示：

/** 一个类注释 */

public class docTest {

/** 一个变量注释 */

public int i;

/** 一个方法注释 */

public void f() {}

}

注意javadoc 只能为 public（公共）和 protected（受保护）成员处理注释文档。“private”（私有）和

“友好”（详见5 章）成员的注释会被忽略，我们看不到任何输出（也可以用-private 标记包括private 成

员）。这样做是有道理的，因为只有public 和protected 成员才可在文件之外使用，这是客户程序员的希

望。然而，所有类注释都会包含到输出结果里。

上述代码的输出是一个 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方法生成的文件会在创建类的对话框选项中提示是否生成注释，默认是选中的。

这样生成的.java文件就有在文件头带有上面设置的版权信息。若是使用New->File方法建立的java文件则不会自动生成文件头的版权信息，必须手动输入。

方法、类、字段等注释：这一类的注释只需要选中方法名、类名、或字段名，然后使用Alt+Shift+J来自动生成注释，然后补全信息即可。望采纳。

转载请注明出处育才学习网 » eclipse怎么写文档注释