注释

Java 文档注释

Java 支持三种注释方式。前两种分别是 // 和 / /，第三种被称作说明注释，它以 /** 开始，以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。
说明注释，使你更加方便的记录你的程序信息。

javadoc 标签

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

标签 描述 示例
@author 标识一个类的作者 @author description
@deprecated 指名一个过期的类或成员 @deprecated description
{@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
@serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据 @serialData description
@serialField 说明一个ObjectStreamField组件 @serialField name type description
@since 标记当引入一个特定的变化时 @since release
@throws 和 @exception标签一样. The @throws tag has the same meaning as the @exception tag.
{@value} 显示常量的值，该常量必须是static属性。 Displays the value of a constant, which must be a static field.
@version 指定类的版本 @version info

文档注释

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。
之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号().
多个相同类型的标签应该放成一组。例如，如果你有三个 *@see 标签，可以将它们一个接一个的放在一起。

  1. import java.io.*;
  3. /**
  4. * 这个类演示了文档注释
  5. * @author Ayan Amhed
  6. * @version 1.2
  7. */
  8. public class SquareNum {
  9.    /**
  10.    * This method returns the square of num.
  11.    * This is a multiline description. You can use
  12.    * as many lines as you like.
  13.    * @param num The value to be squared.
  14.    * @return num squared.
  15.    */
  16.    public double square(double num) {
  17.       return num * num;
  18.    }
  19.    /**
  20.    * This method inputs a number from the user.
  21.    * @return The value input as a double.
  22.    * @exception IOException On input error.
  23.    * @see IOException
  24.    */
  25.    public double getNumber() throws IOException {
  26.       InputStreamReader isr = new InputStreamReader(System.in);
  27.       BufferedReader inData = new BufferedReader(isr);
  28.       String str;
  29.       str = inData.readLine();
  30.       return (new Double(str)).doubleValue();
  31.    }
  32.    /**
  33.    * This method demonstrates square().
  34.    * @param args Unused.
  35.    * @return Nothing.
  36.    * @exception IOException On input error.
  37.    * @see IOException
  38.    */
  39.    public static void main(String args[]) throws IOException
  40.    {
  41.       SquareNum ob = new SquareNum();
  42.       double val;
  43.       System.out.println("Enter value to be squared: ");
  44.       val = ob.getNumber();
  45.       val = ob.square(val);
  46.       System.out.println("Squared value is " + val);
  47.    }
  48. }
  50. $ javadoc SquareNum.java
  51. Loading source file SquareNum.java...
  52. Constructing Javadoc information...
  53. Standard Doclet version 1.5.0_13
  54. Building tree for all the packages and classes...
  55. Generating SquareNum.html...
  56. SquareNum.java:39: warning - @return tag cannot be used\
  57.                       in method with void return type.
  58. Generating package-frame.html...
  59. Generating package-summary.html...
  60. Generating package-tree.html...
  61. Generating constant-values.html...
  62. Building index for all the packages and classes...
  63. Generating overview-tree.html...
  64. Generating index-all.html...
  65. Generating deprecated-list.html...
  66. Building index for all classes...
  67. Generating allclasses-frame.html...
  68. Generating allclasses-noframe.html...
  69. Generating index.html...
  70. Generating help-doc.html...
  71. Generating stylesheet.css...
  72. 1 warning

Applet

https://www.runoob.com/java/java-applet-basics.html