首页 > 代码库 > 《编写可读代码的艺术》——简单总结
《编写可读代码的艺术》——简单总结
上个月好像冥冥中自有安排一样,我在图书馆看到这本 《编写可读代码的艺术》 ( The Art of Readable Code)
期间因为工作的原因,停停看看,这几天终于看完了,可以大概总结如下:
1. 把信息装进名字里,给变量起个好名字
2. 审美,把代码分成段落,对齐
3. 应当取个好名字,而不是用注释去粉饰它
4. 用注释记录你的思想,比如当时为什么要这样写,记录开发过程中有哪些思考
5. 将自己代码中的不足和瑕疵记录下来,方便今后别人的维护,不要顾忌别人的看法!
6. 注释应该言简意赅
7. 当函数有输入输出时,在注释中,最好给出一个具体的例子! // Example: input xxx, output xxx
8. 变量的比较。 if (length >= 10) 左侧是变量,右侧是常量
9. 当表达式很长的时候,用一个解释变量去表示它
if (XXX::XXX()->XXX() == "XXX")可以改进为:
xxx = XXX:XXX()->XXX();
if (xxx == "XXX")
10. 尽量使用const 来限制变量的修改,减少变量的使用,减小变量作用域。
例如在方法参数中,前面的参数是输入参数,尽量用const 修饰,防止在方法中不知不觉修改了。
后面的输出参数尽量用别名
11. 在函数中,抽取出不相关的子问题,思考代码段的最高层次目标是什么?可提高重用性
12. 一个函数,只应该做一件事情
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。