代码规范

最近看了一本叫《代码整洁之道》,虽然只看了前4章,但给我提供的帮助还是很多的,特此写下这一篇读书笔记。

阅读本书有两个原因:第一,你是个程序员;第二,你想成为更好的程序员。 —–《代码整洁之道》

一、为什么要有整洁的代码

归咎两个原因:

  • 可读性好
  • 维护性好

二、有意义的命名

要做到名副其实:变量、函数或类的名称应该已经回复了所有的大问题。它该告诉你,它为什么会存在,它做什么事,应该怎么用。如果名称需要注释来补充,那就不算是名副其实了。而一旦发现有更好的名称,就换掉旧的。

1、尽可能的使用标准命名方法

2、命名要找更有表现力的词

3、变量名称长短应该与其作用域对应

4、别害怕长名称,长而具有描述性的名称比短而费解的名称好

5、类名和对象名应该是名词或名词短语、方法名应当是动词或动词短语

三、注释

1、好的名字比注释更重要

2、给常量加注释

3、在类级别使用全局注释来解释所有部分如何工作

4、团队统一标记

5、无歧义的名称

6、注释应申明代码高层次意图,而非明显细节

7、真正的好注释是你想办法不去写的注释

暂时来说,阅读完前四章,我个人深有体会的是以上两点,后续会慢慢领会这本书的精髓所在

其实我觉得要做到整洁的代码是非常难的,即使你了解了以上所有规则,也不要妄图代码初稿就去完全遵循规则去编写,应该以一种循序渐进的过程来一步步完善重构自己的代码,直到接近完美。