【超级无敌详细的韩顺平java笔记】从入门到精通---注释

一、注释介绍

   用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性（可读性）；注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来，再用代码去体现。Java中有三种类型的注释：

二、注释类型

1. 单行注释 // ：//注释文字
2.  多行注释 /* */ ：/* 注释文字 */
3.  文档注释 /** */

PS：选中要注释的部分，按 ctrl+shift+/ 进行注释，或者输入完 /** +tab 自动补全

---

• 单行注释：
• 用//表示，在//后面添加注释内容。

• // 这是一个单行注释，用来解释该行代码的作用
  int a = 10; // 这也是一个单行注释，用来解释该语句的作用
  

• 多行注释：
• 用/.../表示，可以在注释中添加多行内容。（不能嵌套）

• /* 这是一个多行注释，
     用于解释以下代码的作用 */
  int a = 10; 
  

• 文档注释：
• 注释内容可以被JDK提供的工具Javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档，一般写在类
• 用/**...*/表示，用于生成API文档。文档注释中包含了类、方法等的说明和参数。

• /**
   * @author choclin
   * @version 1.0
  
   */
  	public class  Comment02{
  		public static void main(String[] args){
  			System.out.println("读书");
  		}
  	}

  D:\program Files\java\javacode>javadoc -d d:\\temp -author -version Comment02.java

 

javadoc 标签

标签	描述	示例
@author	标识一个类的作者	@author choclin
@deprecated	指明一个过期的类或成员	@deprecated choclin
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	(@link name text)
{@linkplain}	插入一个到另一个主题的接，但是该创接显示纯文木字体	Inserts an in-line link to another topic.
@param	说明一个方法的套数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description