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() {}
【eclipse怎么写文档注释】}
注意javadoc 只能为 public(公共)和 protected(受保护)成员处理注释文档 。“private”(私有)和
“友好”(详见5 章)成员的注释会被忽略,我们看不到任何输出(也可以用-private 标记包括private 成
员) 。这样做是有道理的,因为只有public 和protected 成员才可在文件之外使用,这是客户程序员的希