7.6. 风格与文档¶
7.6.1. 复习清单¶
虽然风格问题在前面的作业和模块中已经提及，但这份清单将有助于你在提交代码之前审阅代码时保持对风格问题的关注。
通常我们应该避免以下情况：
7.6.1.1. 命名¶
不符合适当命名约定的名称
未能充分捕捉并传达其所代表概念、或其所代表的类、方法、变量或概念目的的命名
过长或过短且描述性不足的名称，即较差的标识符（例如单个字符、歧义缩写、首字母缩略词或首字母）
7.6.1.2. 格式与缩进¶
不一致/缺失的缩进
不足的空格
被注释掉的代码行
代码中遗留的调试语句
每行多条指令或语句过长
7.6.1.3. 文档与注释¶
缺失/不足的类描述
缺失/不足的字段注释
缺失/不足的方法注释
缺失/不完整的 JavaDoc 标签
缺失/不完整的参数描述
错误/误导性的注释
冗余注释或描述性不高于代码的注释
7.6.1.4. 其他风格问题¶
使用硬编码值
缺少或不合适的访问修饰符
不必要的或未使用的字段/变量
