marmot-cn#readingNotes#第十七章 味道与启发1

# 第十七章 味道与启发 --- ### 注释 * 版本控制相关的信息不应该放在注释当中(最后修改时间,修改历史..),注释只应该描述有关代码和设计的技术性信息. * 废弃的注释,最好尽快更新或删除掉 * 不要冗余注释,注释应该谈及代码自身没提到的东西 * 注释不要说废话 * 不要注释掉无用的代码,删除它 ### 环境 * 单个命令签出系统 * 单个指令构建它 * 单个指令就可以运行全部单元测试 ### 函数 * 不要过多的参数,最好没有参数 * 输出参数理解成本高(参数以地址引用格式传递) * `bool`值得参数违背了单一职责,该函数必定会干两件事 * 不要注释掉无用的参数,而是直接删除它 ### 一般性问题 * 尽力减少源文件中额外语言的数量和范围. * 如果函数或类内明显的行为未被实现,读者和用户就不能再==依靠他们对函数名称的直觉==. * 追索每种边界条件,并编写测试. * 处理`warning`级别的报错提示,不要忽视它. * ==重复的代码== = 遗漏了抽象. * 完整的分离不�