Java注释你真的知道了吗?

第一篇博客就随便发点基础知识开开光吧

Java注释你真的知道了吗?

单行注释

正例:

// Hello World
code...

反例:

//Hello World
code...

code... //Hello World

说明:

  • 双斜杠+空格+注释内容
  • 单行注释一般用于注释字段(全局变量,局部变量,常量)

规范:

  • 注释内容前面加个空格这样更美观
  • 尽量写在代码上面而不是右边,否则会导致一行太长影响阅读


多行注释

正例:

/*
 Hello World
*/
code...

反例:

/* Hello World */
code...

/* Hello World
*/
code...

/*
Hello World
*/
code...

说明:

  • 斜杠+星号+回车+空格+注释内容,然后回车星号+斜杠
  • 多行注释一般用于注释需要多行注释的字段

规范:

  • 注释内容前面加空格
  • 不要用多行注释来注释单行内容,这样没有意义

文档注释

正例:

/**
 * Hello World
 */
 code...
 
/**
 * @author xxx
 * @date 2020/07/30
 * @see xxx.xxx.Class
 */
 class...
 
/**
 * @param 参数名 描述
 * @return 描述
 */
 method...

反例:

/**
 Hello World
 */
 code...

说明

  • 斜杠+双星号+回车+星号+空格+注释内容,然后回车+星号+斜杠
  • 对关键处可以用 @name xxx 来描述,例如上面的@param
  • 文档注释一般用于注释类和方法,但也可以注释字段
  • 与多行注释开头不同,它开头是斜杠+双星号

规范:

  • 当一个方法有参数或返回值时需要用@param和@return描述
  • 注释内容前面加一个星号再加个空格,不加也可以只是不美观




PS:规范之所以是规范而不是规则是因为你可以轻易的违背它!

©️2020 CSDN 皮肤主题: 数字20 设计师:CSDN官方博客 返回首页