如何写Java文档注释

“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释,它是一种带有特殊功能的注释。文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。比如:/**这是文档注释*/ /* 这是一般注释*/ // 这是一般注释 在一些IDE(比如Eclipse)中,文档注释会以不同于普通...
如何写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工具更好地生成最终文档。所以,虽然有些标记写起来麻烦且看着不直观,还是要老老实实按规矩写滴。
原文地址:网页链接
2017-10-27
//注释内容
就按着这个格式就好2017-10-27
/**
注释的内容
*/2017-10-27
mengvlog 阅读 29 次 更新于 2025-09-09 22:27:53 我来答关注问题0
  •  翡希信息咨询 如何写Java文档注释

    文档注释采用HTML语法规则书写,支持HTML标记。可以使用HTML标签来格式化注释内容,如、、等。JavaDoc特定标记:除了HTML标记外,JavaDoc还支持一些特定的标记,如@param、@return、@throws等,用于描述方法的参数、返回值和可能抛出的异常。这些标记的作用是为了让javadoc工具更好地生成最终文档,虽然它们写起来...

  • (1)单行注释:以“ // ”开头后面接所要加的说明的内容。如下面所示: //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中,在编译的过程就会直接略过注释,只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。(2)多行注释:以...

  • /**这是文档注释*/ /* 这是一般注释*/ // 这是一般注释 在一些IDE(比如Eclipse)中,文档注释会以不同于普通注释的颜色高亮显示。此外,文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地,文档注释必须写在类、接口、方法、构造器、成员...

  • 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在...

  •  母婴小贴士来啦 java注释快捷键是什么?

    2、多行注释:Ctrl+Shift+/(Windows)或Command+Shift+/(Mac)。在代码块的开头和结尾添加/*和*/,快速添加多行注释。这对于添加详细的代码说明非常有用。3、生成Javadoc注释:/**+Enter。在Java方法或类的开头输入/**,然后按Enter键,将自动生成Javadoc注释模板。这对于编写文档和API文档非常有用...

檬味博客在线解答立即免费咨询

Java相关话题

Copyright © 2023 WWW.MENGVLOG.COM - 檬味博客
返回顶部