在IDEA编写Java代码的程序注释

目录

 1.单行注释

2.多行注释,块注释

3.文档注释

1.打开工具(idea tools菜单 Generate JavaDoc... )

2.设置生成参数

---

首先在setting中进行设置(本文展示中文版,英文版是在editor > code style > java Code Generation中进行设置 )

 1.单行注释

ctrl + / 添加取消行注释

package cn;
public class So {
    public static void main(String[] args) {
        //单行注释 快速ctrl + /
        //int n = 10;
        //System.out.println(n);
    }
}

2.多行注释,块注释

package cn;
public class So {
    public static void main(String[] args) {
        //ctrl + shift + / 块注释，多行注释
        /*
        for (int i = 0; i < 10; i++) {
        System.out.println("%03d%n", i);
        }
        */
    }
}

3.文档注释

        文件注释，类注释，属性注释，方法的注释这些注释和类的结构属性和一个javadoc.exe 命令相关，javadoc 命令可以根据文字的这些信息，快速生成类的 api 参考网页。

/*
 * Copyright (c) 2020, 2023, lzq.cn All rights reserved.
 *
 */
package cn;

/**
 * 
Project: jiaocheng - T1
 * 
Powered by lzq On 2023-07-05 17:34:55
 * 
描述：

 *
 * @author lzq [[email protected]]
 * @version 1.0
 * @since 17
 */
public class T1 {
    public static void main(String[] args) {
        //ctrl + shift + / 块注释，多行注释
        /*
        for (int i = 0; i < 10; i++) {
        System.out.printf("%03d%n", i);
        }
        */
    }
    /**
     * Description: 使用此快捷方式，在方法上输入/mm
     * @date: 2023/2/7 10:24
     * @params: [int]
     * @return: int
     */
    public int pf(int i) {
        return i * i;
    }
}

1.打开工具(idea tools菜单 Generate JavaDoc... )

 点击生成JavaDoc

2.设置生成参数

 1.设置想要生成的区域.

2.设置输出目录

3.设置输出的语言

zh_CN

4.设置命令行实参

-author -version -charset utf-8 -encoding utf-8 -windowtitle OA软件系统 -locale zh_CN

点击生成后会直接跳转到默认浏览器打开

生成的文件目录如下图所示