3-注释

目录

1.基本规则

2.注释规范

---

注释是为了让代码更容易被读懂而附加的描述信息。程序中允许加空白的地方就可以写注释，编译器会忽略所有注释，不参与编译运行。

1.基本规则

Java中的注释主要分为以下三种：

1.1.单行注释：//注释内容（用的最多）

1.2.多行注释：/*注释内容*/（不推荐）

1.3.文档注释：/**文档注释*/（常见于方法和类之上描述方法和类的作用），可用来自动生成文档。

2.注释规范

2.1.内容准确：注释内容要和代码一致，匹配，并在代码修改时及时更新。

2.2.篇幅合理：注释内容既不能太精简，也不能长篇大论。

2.3.使用中文：一般中国公司要求使用中文写注释，外企另当别论。

2.4.积极向上：注释中不要含有负能量。