Question

java 文档注释是注释什么的,不是有多行注释了吗?

Answer 1

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。

使用文档注释时，需要在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释的内容可以生产一个开发者文档。

扩展资料

java常用的文档注释标签

1、@author：标识一个类的作者

实例： @authordescription

2、@deprecated：指名一个过期的类或成员

实例： @deprecateddescription

3、@exception：标志一个类抛出的异常

实例：@exceptionexception-nameexplanation

4、{@inheritDoc}：从直接父类继承的注释

实例：Inheritsacommentfromtheimmediatesurperclass.

5、{@link}：插入一个到另一个主题的链接

实例：{@linknametext}

6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体

实例：Insertsanin-linelinktoanothertopic.

7、@param：说明一个方法的参数

实例：@paramparameter-nameexplanation

8、@return：说明返回值类型

实例：@returnexplanation

9、@see：指定一个到另一个主题的链接

实例：@seeanchor

10、@serial：说明一个序列化属性

实例：@serialdescription

参考资料：百度百科-java注释