2.1 单行注释
- 独占一行的注释，用来解释下一行代码。这行注释之前总有一个空行，且缩进层级和下一行代码保持一致。
- 在代码行的尾部注释，代码结束到注释之间至少要有一个缩进。注释不应该超过单行最大字数限制，如果超过了，就将这条注释放置于当前代码行上方。
- 单行注释不应当以连续多行注释的形式出现，除非你注释掉的是一大段代码。
- 只有当要注释掉一段很长的文本时才使用多行注释。
2.2 多行注释
使用Java风格的多行注释
/*
* 这是一段注释
* 这是第二行注释
*/
- 第一行 /*
- 第二行 * ，且和上一行对齐，且与内容之间有一个空格
- 第三行 */
- 内容从第二行开始写，最后一行没有内容
- 同单行注释一样，注释之前应该有一个空行，且缩进层级与要描述的代码段保持一致
2.3 使用注释
- 难于理解的代码，当代码不够清晰时添加注释，而当代码很明了时不应当添加注释。
- 可能被别人误认为是错误的代码，其实他并不是错误的，要提醒别人
- 浏览器hack
2.4 文档注释
与多行注释类似。以/**开始。使用@符号来不是属性和参数
网友评论