1.4、Java - 【 代码注释 】

目录

 代码注释

1.单行注释

语法如下：

例如，以下代码为声明int型变量添加注释：

2.多行注释

语法如下:

例如，以下代码为添加方法后添加多行注释：

3.文档注释

语法如下：

例如，以下代码为添加方法后添加文档注释：

---

 代码注释

1.单行注释

" // "为单行注释标记，从符号" // " 开始直到换行位置的所有内容均作为注释而被编译器忽略。

语法如下：

//注释内容

例如，以下代码为声明int型变量添加注释：

int age ; //声明int型变量，用于保存年龄信息

2.多行注释

“ /* */ ”为多行注释标记,符号“ /* ”与 " */ " 之间的所有内容均为注释内容。注释中的内容可以换行。

语法如下:

/* 
   注释内容1 
   注释内容2 
   ...       
      */

例如，以下代码为添加方法后添加多行注释：

package cn.api.demo 
public class User{ 
    /* 
        main方法是主方法的入口 
    */ 
public static void main(String [] args){ 


    }
}

3.文档注释

" /** ....*/ "文档注释标记。符号" /** "与 " */ " 之间的内容均为文档注释内容。当文档注释出现在声明(如类的声明、类的成员变量声明、类的成员方法声明等)之前时,会被Javadoc文档工具读取作为Javadoc文档内容。对于初学者而言，文档注释并不是很重要，了解即可。

语法如下：

/** 
 * 文档注释 
 */

例如，以下代码为添加方法后添加文档注释：

package cn.api.demo 
public class User{ 
    /** 
     * 文档注释
     * main方法是主方法的入口
     */
 public static void main(String [] args){ 


       }
}