有意义的命名
名副其实
不管是变量、函数或者类,它们的命名应该与它们要做的事有关;
避免误导
必须避免留下掩藏代码本意的错误线索;
- 别用accountList来指定一组账号,除非真的是List;
- 避免使用名称太过相似的字符串;
- 避免使用单个“O”或“l”单个字符表示变量名;
使用可搜索的名称
名称长短应与其作用域大小相对应,比如在方法中的局部变量名可以使用单个字符表示,若是整个类或者类外引用需要使用大写短语表示,便于搜索。
避免思维映射
避免将想要表达的英文变量名映射成的那个字符,不便阅读;
类名
类名和对象名应该是名词或名词短语,不应该是动词;
方法名
方法名应当是动词或动词短语,属性访问器、修改器和断言应该根据其值命名;
函数
短小
函数第一规则就是短小;函数的缩进层级不应该多于一层或两层;
只做一件事
一个函数应该只做一件事,而只做一件事的函数无法被合理地切分为多个区段;
每个函数一个抽象层级
函数中的语句都要在同一抽象层级上。让代码拥有自顶向下的阅读顺序,让每个函数后面都跟着位于下一抽象层级的函数。
switch语句
确保switch语句都埋藏在较低的抽象层级,而且永远不重复;
函数参数
最理想的参数数量是0,其次是1,再次是2,使用三个参数则需要足够的理由。