MIT6.031 软件构造 Reading4阅读笔记Code Review

来自MIT6.031 软件构造课的Reading材料的第4篇。

重点讲授了

Code Review的意义,相关知识。
用其余的篇幅讲解了常用的代码规范内容,包括:

  • Don’t Repeat Yourself (DRY)

用代码复用代替复制粘贴

  • Comments where needed

在需要的时候 要注释 + 才注释

  • Fail fast

如果出现错误,尽快挂断,避免传递错误结果

  • Avoid magic numbers

避免使用奇怪的来历不明的数字,用更有意义的方式表达

  • One purpose for each variable

每个变量名只是用一种含义,不复用

  • Use good names

使用良好意义好的变量名

  • No global variables

避免全局变量,尽可能缩小变量作用域

  • Return results, don’t print them

在底层,返回结果,而非与用户交互

  • Use whitespace for readability

使用空格字符,如果要用Tab键,可使用编辑器转化成空格

具体内容及笔记见下图,笔记主要以手写方式提供。

MIT官网直通车

在这里插入图片描述
在这里插入图片描述

发布了90 篇原创文章 · 获赞 65 · 访问量 1万+

猜你喜欢

转载自blog.csdn.net/ctsnevermore/article/details/105036761