注释的理解

特点:

1. 注释不需要运行， 所以没有常规的办法来测试它。 注释对不对？ 有没有随着代码变更？ 这些问题都是写注释需要注意的地方。

2. 注释难以维护， 这是使用注释带来的最大的麻
   烦

3. 注释， 被我们用成万能的狗皮膏药， 有时会让代码更糟糕

4. 注释的类型多样 ,难以统一

心得

1.使用准确、 有意义的命名，不要滥用注释

注释的类型多样

第一种类型， 是记录源代码版权和授权的， 一般放在每一个源文件的开头， 说明源代码的版
权所有者， 以及授权使用的许可方式， 或者其他的公共信息。

第二种类型， 是用来生成用户文档的，

第三种类型， 是用来解释源代码的

三种风格的注释

• 注释类型， 也就是固定的版权和授权信息， 使用一般的星号注释符（ /-/）

/*
* Copyright (c) 2018, FirstName LastName. All rights reserved.
*/

• 第二种注释类型， 即生成用户文档的注释， 使用Javadoc要求的格式， 文档注释符（ /-*/） 。 除了首行使用特殊的文档注释符（ /） ，

/**
* A {@code Readable} is a source of characters. Characters from
* a {@code Readable} are made available to callers of the read
* method via a {@link java.nio.CharBuffer CharBuffer}.
* *
@since 1.5
*/
public interface Readable {
...
}

• 第三种注释类型， 也就是代码解释注释， 只使用行注释符（ //） 。 每行长度限制， 和代码块的每行长度限制保持一致。

//
Verify that the buffer has sufficient remaining
private static void verifyLength(
ByteBuffer buffer, int requiredLength) {
...
}

注释的三项原则

1. 准确， 错误的注释比没有注释更糟糕。
2. 必要， 多余的注释浪费阅读者的时间。
3. 清晰， 混乱的注释会把代码搞得更乱。

比如， 当我们说编程语言时， 一定不要省略“编程”这两个字。 否则， 就可能会被误解为大家日常说话用的语言。 这就是准确性的要求。

注释用英文

接受度
它会影响到编码风格的偏好
由于代码命名只能使用ASCII字符， 注释里的拼音、 英文、 汉字混杂的问题该怎么处理？