小猴子的第一篇文章-markdown编辑器

关于学习代码注释后的一些学习心得

代码注释的三大类

1.单行注释 //
2.多行注释 //
3.文档注释 /**…*/

单行注释

一般单行注释,注释少量代码或者说明内容

  1. 样式://我是被注释的内容;
  2. 快捷键:ctrl+/ 或 ctrl+shift+C,一般在代码书写上不用快捷键,直接双击//;
  3. 用法: 单行注释一般用在方法中解释一条语句的含义。比如;
 public static boolean sushu(int x) {
        for (int i = 2; i < x; i++) {
            if (x % i == 0) {
                //如果为真,则返回值为false
				return false;
            }
        }
        return true;
    }
 [^1]: [m

ermaid语法说明](https://mermaidjs.github.io/)

多行注释

一般使用多行注释大量的代码或者说明内容

  1. 样式::/我是被注释的内容/ ;
  2. 快捷键:ctrl+shift+/;
  3. 用法:多行注释一般用于类中来解释一个或多个方法,写在方法的外面。
    /*
	主方法
	*/
	public static void main(String[] args) {
		bbq();
	}

文档注释

文档注释一般用于对类和方法进行功能说明

  1. 样式::/*我是被注释的文档/;
  2. 快捷键:Alt+shift+J;
  3. 用法 :文档注释用于代码开头作为整个代码的解释,或用于方法封装的需求分析。比如
 /*
需求
	展示一个烤羊排~~~,sout

方法分析
	public static 固定格式,不要问
	返回值类型: void 
	方法名: bbq
	形式参数列表: ()

方法声明:
	public static void bbq()
*/
/**
* 打印烤羊排~~~
*/
public static void bbq() {
    System.out.println("烤羊排!!!");
}

备注:本人新手,若有问题,请各位读者指正。

发布了16 篇原创文章 · 获赞 4 · 访问量 767

猜你喜欢

转载自blog.csdn.net/sjn2212297386/article/details/104217485