【置顶】代码整洁之道之于我

更新于2019-11-14

最近完成了一个需要和人对接与合作的小项目，合作的时候出现了partner只想把自己的工作做完，不愿意去过问整体进度、对接的流程和自己的代码交付后对方如何维护的问题，情绪上一度低沉与"是否自己太多管闲事"的自我怀疑。

项目完结后思考了许久，的确，完成手头工作通常会成为我们的priority，完成后人通常又是懒惰/有其他事情要忙的。但是其一，对自己的代码负责，书写后期可以方便阅读/维护的代码本就是一个合格程序员的基本素养，即使不完美也应尽可能的做好而非留待以后和别人去做；其二，一个人工作的发展方向一定应朝着更高层次的视角迈进，一个水桶装多少水在于短板，一个项目完成多好在于互相配合的意愿、集体高效的沟通交流与每个人完成自己的任务。对我而言，做村里最牛逼的石匠绝对不是我的终极目标，我想和大家一起建一座城堡。

现实中工作时的摩擦和烦恼不是喊喊口号，讲讲梦想，所以记下自己的本心时时自省，以后在学习中变得更加沉稳吧。

-------------------------------------------------------------------------------------------------------------------------

2019-10-27

前言：

读了浅墨大神的《代码整洁之道》精读与演绎，结合自己最近学习中遇到的一些问题，做一些笔记提醒自己。

1、恰如其分的使用注释

一个好的变量、函数、类名应能告诉你该名称代表的内容什么意义、做了什么事情、怎么用

注释应锦上添花而非增加无用阅读量，下面第二行>第一行

int d; // elapsed time in days||经过了几天时间

int elapsedTimeInDays;

2、做有意义的区分

提防长的太像的名称

避免数字、字母系列命名

精简准确、直截了当、避免废话 如product 和 productInfo

3、命名习惯

类名用名词；

方法用动词开头；

以前缀区分全局变量与私有变量；

每个概念对应一词，一以贯之

4、函数

短小，尽可能短小

单一职责，只做一件事

命名具有描述性且命名方式与模块保持一致

减少参数，避免三参数及以上的用法，不要出现标记符参数而是替换成两个函数分别处理

避免重复（与第二条原则相同）

5、格式

源文件一目了然，最顶部给出高层次概念与算法声明。

少量注释+整洁有力的代码>大量注释+复杂代码

合理利用空白行隔开命名空间、类、函数；同类型代码靠近

A调用B，A放在B上方

变量的声明靠近其使用位置

团队代码规范一致

6、类

公有静态常量、私有静态常量、公有变量、私有变量、公共函数（+公共函数调用的私有工具函数）

尽可能保持变量和函数的私有性

类应该短小——单一权责原则（SRP）

提高类的内聚性：类的内聚性就是类中变量与方法之间的依赖关系

有效修改隔离：具体类包含实现细节（代码），而抽象类则呈现概念

小结：

程序员要做的不是尽力避免错误，而是聚焦在快速发现并改正错误。"快速的失败"远胜过"预防错误"。

【置顶】代码整洁之道之于我

原文：https://www.cnblogs.com/littlepangdi/p/11867739.html