代码整洁之道
Shopee_Rex
学习ing
展开
-
《代码整洁之道》笔记03——注释
注释是在代码表达意图时遭遇的失败。 注释不能美化糟糕的代码 用代码来阐述 好注释 法律信息 对基本信息的注释 对意图的解释 阐释 警示 TODO注释,程序员认为应该去做,但是由于一些原因没用实现完的注释。 放大不合理之物的重要性 公共API描述 坏注释 喃喃自语/废话注释 多余的注释 误导性注释 循规式注释:不需要给每一个函数进行注释 日志式注释 能用函数和变量时就别用注释 用于位置标识的注...原创 2020-05-06 00:44:07 · 269 阅读 · 0 评论 -
《代码整洁之道》笔记02——函数
函数主体短小 函数应该以完成功能为前提,函数主体能短小就多短小。 一件事 函数应该只完成一件事,如果函数存在多种事件处理,需要进行解构整合。如果该函数处理的都在同一抽象层,则代表该函数制作一件事。 每个函数一个抽象层级 自顶向下阅读,如果出现不同抽象层级的应当进行重构。 Swtich语句 尽量将它使用到抽象底层 使用描述名称 函数越短小,功能越集中,就越容易取得好名称。不要害怕长名称。 函数参数 ...原创 2020-05-06 00:42:53 · 318 阅读 · 0 评论 -
《代码整洁之道》笔记01——有意义的命名
有意义的命名 名副其实 例如代码中如果出现thsList,theArray这些命名,应该赋予更加具有实际用途的命名。 比如用于保存用户名的数组:usersNameArray 避免误导 避免留下掩藏代码本意的错误线索。例如: 使用了语言的预留的变量名 使用了与系统设计有误导的命名:userNameList如果这个变量名不是一个List类型 使用大写的O小写的l来命名变量,使之看起来像数字的 0,1...原创 2020-05-06 00:41:45 · 275 阅读 · 0 评论 -
《代码整洁之道》笔记04——数据结构
数据抽象 隐藏变量内部结构,可以通过抽象取值和设置的方法,让用户无须关心数据的实现而就能操作数据本体。 例如: class Point { getX:function(){}; getY:function(){}; setX:function(){}; setY:function(){}; } 当然并不是一味的暴露取值和赋值器就可以完成。 例如: class Vehi...原创 2020-05-06 00:45:08 · 297 阅读 · 0 评论