<代码整洁之道四> 优秀代码的格式标准
  1. 像报纸一样一目了然。名称应该简单并一目了然,源文件顶部应该给出高层次概念和算法,细节应该往下渐次展开,直到找到源文件中最底层的函数和细节。

  2. 恰如其分的注释。带少量注释的整洁而有力的代码,比带有大量注释的零碎而复杂的代码更加优秀。

  3. 单文件行数不要太长,尽可能几百行以内。

  4. 合理利用空白行。命名空间、类、函数之间,都用空白行隔开。

  5. 让紧密相关的代码互相靠近。

  6. 基于关联的代码分布:变量声明靠近使用位置、实体变量在类的顶部声明、函数调用者放在被调用函数的上面

  7. 团队应该遵循一套代码规范。


20160821193804000.png


来源:【《代码整洁之道》精读与演绎】之四 优秀代码的格式准则


首页 我的博客
粤ICP备17103704号