Java 注释

Java 有三种注释：

1. 单行注释
2. 多行注释
3. 说明注释

 

注意：

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅写在类、属性、方法之前

 

1. 单行注释 快捷键（Ctrl + /）：

//注释的内容

1. 多行注释 快捷键（Ctrl + \）:

/*注释的内容*/

1.  说明注释 快捷键（/* + 按两次Enter键）

/*

 *

*/

说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息，并输出到HTML文件中。

说明注释，使你更加方便的记录你的程序的信息。

javadoc 标签

javadoc工具软件识别以下标签：

 

 

文档注释：

在开始的/**之后，第一行或几行是关于类、变量和方法的主要描述.

之后，你可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

多个相同类型的标签应该放成一组。例如，如果你有三个@see标签，可以将它们一个接一个的放在一起。

下面是一个类的说明注释的示例：

/*** This class draws a bar chart.

* @author Zara Ali

* @version 1.2

*/

这下面则是一个类不写任何方法时的注释案例：

只显示其自己的用户名

/**

 *

 * @author Thief

 *

 */

javadoc输出什么：

1. javadoc工具将你Java程序的源代码作为输入，输出一些包含你程序注释的HTML文件。
2. 每一个类的信息将在独自的HTML文件里。javadoc也可以输出继承的树形结构和索引。
3. 由于javadoc的实现不同，工作也可能不同，你需要检查你的Java开发系统的版本等细节，选择合适的Javadoc版本。

实例：

下面是一个使用说明注释的简单实例。注意每一个注释都在它描述的项目的前面。

在经过javadoc处理之后，SquareNum类的注释将在SquareNum.html中找到。

package com.LR.Date;

import java.io.*;



/**

* This class demonstrates documentation comments.

* @author Thief

* @version 1.2

*/

public class SquareNum {

   /**

   * This method returns the square of num.

   * This is a multiline description. You can use

   * as many lines as you like.

   * @param num The value to be squared.

   * @return num squared.

   */

   public double square(double num) {

      return num * num;

   }

   /**

   * This method inputs a number from the user.

   * @return The value input as a double.

   * @exception IOException On input error.

   * @see IOException

   */

   public double getNumber() throws IOException {

      InputStreamReader isr = new InputStreamReader(System.in);

      BufferedReader inData = new BufferedReader(isr);

      String str;

      str = inData.readLine();

      return (new Double(str)).doubleValue();

   }

   /**

   * This method demonstrates square().

   * @param args Unused.

   * @return Nothing.

   * @exception IOException On input error.

   * @see IOException

   */

   public static void main(String args[]) throws IOException

   {

      SquareNum ob = new SquareNum();

      double val;

      System.out.println("Enter value to be squared: ");

      val = ob.getNumber();

      val = ob.square(val);

      System.out.println("Squared value is " + val);

   }

}