详述Java三种注释方法及实例说明

1.注释方法汇总(实例说明在第二部分)

 1.1单行注释

        (1)符号: //

        (2)注释范围:从符号 “ // ” 开始,到本行结束

        (3)快捷键  “  Ctrl + ” (Ctrl 和 / 的组合):

        选中要注释的内容,按 “ Ctrl + / ”,便可“同时单行注释多行内容”。(若想多个同个取消,则选中“以及单行注释过的内容”,再次按Ctrl+/ 组合键即可同时取消多个单行注释。)


1.2 多行注释

        (1)符号:/*   */

        (2)注释范围:从左边“  /*  ” 开始,到右边 “  */  ”结束

        (3)快捷键  “  Ctrl + shift + ” (Ctrl 、Shift 和 / 的组合):

        选中要注释的内容,按 “ Ctrl + shift + /​​​​​​​  ”,便可用多行注释的方法注释选中的内容。


1.3 文档注释

        (1)符号:/**   */

        (2)注释范围:一般用在函数前面,Java编译器会自动读取邻近函数体中的关键变量等要素,辅助开发人员进行“函数”说明。

        (3)使用方法在要进行文档注释的函数前面一行输入“  /** ”(一个 “  /  ”和两个“ ** ”),之后按回车即可,Java编译器会自动提取。

2.逐个实例说明

(1)单行注释 ( //  )

public class ExplainMethod {
    public static void main(String[] args) {

        // 1—— 单行注释
        // 我是单行注释,我从“ // ”开头到这行结束为止
        // 你可以用 快捷键  “  Ctrl + /  ” (Ctrl 和 / 的组合)设置
        //选中要注释的内容,按 “ Ctrl + / ”,便可“同时单行注释多行内容”。
        //(若想多个同个取消,则选中“以及单行注释过的内容”,再次按Ctrl+/ 组合键即可同时取消多个单行注释。)

    }
}

(2)多行注释 ( /*  */ )

public class ExplainMethod {
    public static void main(String[] args) {
        
        // 2—— 多行注释
        
        /*
            (1)我是  多行注释,从左边“  /*  ” 开始。

            (2) 开始 、结束 符号之间 都是我的”注释范围,所以我称为——“多行注释”。
            
            (3) 你可以用——快捷键  “  Ctrl + shift + /​​​​​​​  ” (Ctrl 、Shift 和 / 的组合):
            选中要注释的内容,按 “ Ctrl + shift + /​​​​​​​  ”,便可用多行注释的方法注释选中的内容。
            
         */
        
    }
}

(3)文档注释( /**  */ )

public class ExplainMethod {
    public static void main(String[] args) {
        
    }
    // 3—— 文档注释
    // 我是文档注释,在要进行文档注释的函数前面一行输入“  /** ”(一个 “  /  ”和两个“ ** ”),之后按回车即可,Java编译器会自动提取。

    /**
     * 文档注释
     * 
     * @args
     */
    public static void documentAnnotation(){
        System.out.println("测试 文档注释");
    }
}

3.综合说明

public class ExplainMethod {
    public static void main(String[] args) {
        // 1—— 单行注释
        // 我是单行注释,我从“ // ”开头到这行结束为止
        // 你可以用 快捷键  “  Ctrl + /  ” (Ctrl 和 / 的组合)设置
        //选中要注释的内容,按 “ Ctrl + / ”,便可“同时单行注释多行内容”。
        //(若想多个同个取消,则选中“以及单行注释过的内容”,再次按Ctrl+/ 组合键即可同时取消多个单行注释。)



        // 2—— 多行注释

        /*
            (1)我是  多行注释,从左边“  /*  ” 开始。

            (2) 开始 、结束 符号之间 都是我的”注释范围,所以我称为——“多行注释”。

            (3) 你可以用——快捷键  “  Ctrl + shift + /​​​​​​​  ” (Ctrl 、Shift 和 / 的组合):
            选中要注释的内容,按 “ Ctrl + shift + /​​​​​​​  ”,便可用多行注释的方法注释选中的内容。

         */

    }

    // 3—— 文档注释
    // 我是文档注释,在要进行文档注释的函数前面一行输入“  /** ”(一个 “  /  ”和两个“ ** ”),之后按回车即可,Java编译器会自动提取。

    /**
     * 文档注释
     *
     * @args
     */
    public static void documentAnnotation(){
        System.out.println("测试 文档注释");
    }
}

猜你喜欢

转载自blog.csdn.net/m0_54158068/article/details/125116791
今日推荐