Java 注释语句

Java教程 - Java注释语句

源代码中的注释提供有关源代码的信息。这是一个很好的做法是编写注释来记录源代码

Java中支持三种类型的注释。

1. 单行
2. 多行
3. 文档注释

单行注释

Java单行注释从 // 开始，结束到该行结束。

public class Main {
  // This is a single line comment.
  public static void main(String[] argv) {
  }

}

多行注释

Java多行注释在 /* 和 */ 之间。编译器忽略从 /* 到 */ 的所有内容。

public class Main {
  /* This 
     is 
     a
     Multiline 
     comment.
  */
  public static void main(String[] argv) {
  }

}

Java文档注释(Javadoc)

Javadoc文档注释用于生成用于记录程序的HTML文件。总之我们通常调用Java文档评论javadoc。

Javadoc注释占用一行或多行源代码。文档注释以 /** 开头，并以 */ 结尾。从/**到*/的所有内容都被编译器忽略。

以下示例演示Javadoc注释:

/** 
* Application entry point 
* 
* @param args array of command-line arguments passed to this method 
*/ 
public static void main(String[] args) 
{ 
// TODO code application logic here 
}

此示例从描述main()方法的Javadoc注释开始。 /** 和 */ 包含方法的描述，其可以包括诸如的HTML标签<p> ，<code> 和 /</code> 和 @param Javadoc标记(一个@前缀指令)。

以下列表标识几个常用的标签:

• @author 标识源代码的作者。
• @deprecated 标识不应再使用的源代码实体。
• @param 标识方法的参数之一。
• @see 提供了一个see-also参考。
• @since 标识实体首次发起的软件版本。
• @return 标识该方法返回的值的类型。

以下代码具有更多的文档注释

/**
 * A simple class for introducing a Java application.
 * 
 * @author yourName
 */
public class HelloWorld {
  /**
   * Application entry point
   * 
   * @param args
   *          array of command-line arguments passed to this method
   */
  public static void main(String[] args) {
    System.out.println("Hello, world!");
  }
}

我们可以使用JDK的javadoc将这些文档注释提取到一组HTML文件中工具，如下:

javadoc 命令默认为为公共类和生成基于HTML的文档公共/受保护的成员。