标签：Java description explanation Day06 用法 注释 实例 文档 link

注释种类

1. 单行注释：只能注释一行文字
2. 多行注释：可以注释一段文字
3. 文档注释：用来生成说明文件

注释符号及用法

1. 单行注释：//

   • //后面写注释

2. 多行注释：/**/

   • /*
   • 我是注释
   • 我是注释
   • 我是注释
   • */

3. 文档注释：/***/

   • /**加回车即可打出文档注释的框架

   • java常用的文档注释标签

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

     实例： @author description

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

     实例： @deprecated description

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

     实例：@exception exception-name explanation

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

     实例：@inheritDoc Inherits a comment from the immediate surperclass

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

     实例：@link name text

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

     实例：@inheritDoc Inserts an in-line link to another topic

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

     实例：@param parameter-name explanation

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

     实例：@return explanation

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

     实例：@see anchor

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

     实例：@serial description

标签：Java,description,explanation,Day06,用法,注释,实例,文档,link
来源： https://www.cnblogs.com/sqk950143960/p/16626148.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。