java 段注释 java怎么注释

转载

mob64ca14137e4f 2023-08-14 15:14:24

文章标签 java 段注释 java 开发语言 jvm 文档注释 文章分类 Java 后端开发

（一）掌握Java程序的注释用法

程序注释用来对程序中的代码进行说明。注释的内容在程序运行时会被编译器忽略，因而不参与程序的运行。
Java有三种程序注释方式，分别为单行注释、多行注释和文档注释，其特点如下：

①单行注释以双斜杠“//”开始，终止于本行结束。单行注释多用于对一行代码的简短说明。

②多行注释以“/”开始，以“*/”结束，两者之间的所有字符都是多行注释的内容。多行注释通常用于对文件、方法、数据结构等的说明，或者算法的描述。多行注释一般位于方法的前面，起引导作用，也可以根据需要放在其他合适的位置。

③文档注释以“/**”开始，以“*/”结束，在此之间的所有字符都是文档注释的内容。文档注释主要是为了支持JDK工具javadoc，通过javadoc，文档注释将会生成HTML格式的代码报告，因此文档注释应当书写在类、构造方法、成员方法以及常量或变量的定义之前。
相关代码：

package com.sxt;

import java.io.*;

/**
 * 这个类演示了3.文档注释
 * @author Ayan Amhed
 * @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
     */
    //1.单行注释（在这一行后面无论写啥都参与编译器运行）
    /*（在这一区域无论写啥都参与编译器运行）
    2.多行注释;
    hhhh；
    哈哈哈;
     
     */
    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);
    }
}