代码整洁之道(一)——初学笔记

原创 2015年11月19日 19:28:49

项目收尾阶段,自由时间相对充裕些,所以买了《代码整洁之道》等五本编程规范的书籍,边学习,边整理以前做过的代码,希望以后能不用反复整理,就能写出出色的项目代码。
以下是学习到的一些规范整理:
1.变量,函数等的命名要可读(英文拼写,驼峰式);一定不要用简单的字母,或者a1,a2这种,同时尽量不要用缩写;命名的详细程度(拼写)和它的作用域大小相对应;但是表述同样语境用词越少越好,精——简
2.同样是精——简,函数内容应当尽量简单明了,复杂的case判断,最好写成语句或函数赋予给一个bool标识符,加上少量注释,或者说标识符的拼写能够直接表达;函数内的if,while,else这些语句的缩进要尽量减少,不多于两层。
函数应该做一件事。做好这件事。只做这一件事!
3.写成只停留在一个抽象层级的函数
4.最理想的函数参数数量是零,其次是1或2,最好不要用三个以上的参数
5.函数和其参数最好形成明显的动车/名词对形式
6.this远比输出参数的方式要好,函数的参数最好只是输入参数,不然可读性差
7.拒绝使用返回错误标识,而是用抛出异常来表示;不在函数中直接使用try/catch,而是一个函数只有try/catch一个抽象功能,而后这个功能用一个函数描述,抛出这个异常。即函数只做一件事
8.别给糟糕的代码加注释,直接重写吧!,需要加过多的注释,本身就是一种失败,因为编程就是一种表达方式。注释如果跟不上程序的更新节奏,陈旧的注释可信度非常低
9.循环中的控制变量总是在循环语句中声明;实体变量总是在类的顶部声明。
10.相关函数:若某个函数调用了另一个函数,应该把它们放到一起(我更倾向于编程时思考每个功能,按抽象层级先构建函数声明和返回值,然后逐步完善内容,这样相关函数自然垂直距离更近)
11.德墨忒尔定律,模块不应了解他所操作对象的内部情形,即不要开火车(A.f().g().h()),避免一步错,步步错。类似A.b.c.d还可以。
12.别返回null值
13.API学习之道:*学习性测试*
14.整洁测试的要素:可读性,可读性,可读性!
15.测试步骤:构造——操作——检验
16.断言
17.整洁测试遵循的五条规则(FIRST):快速,独立,可重复,自足验证,及时。
18.自顶向下
19.

版权声明:本文为博主原创文章,未经博主允许不得转载。

[读书笔记] 代码整洁之道(一)

最近读完了马丁的clean code,颇有收获,简单整理下读书笔记,虽然整书是以Java代码做代码示例,但语言无国界,特别是编程语言更是如此,不管你从事的是以何种语言为主的开发环境,我相信,从本书中都...

(读书笔记)代码整洁之道-函数

代码整洁之道–函数 函数 1.短小 作者认为函数应该尽量短小,最多20行左右。 代码换最好只有一行,例如if()只有一行,用于调用函数。 函数的缩进也尽量一层到两成2.只...

CleanCode《代码整洁之道》读书笔记

总结,基本和目录也差不多。用来时刻提醒自己编写可维护,易读的代码 第一章 第二章 第三章 函数 1.函数要短小 2.一个函数只包含一个功能 3.函数里尽量只包含一个缩进,有利于文档的注释和代码的理解...

代码整洁之道读书笔记

自从进入游戏开发团队以后,最近一直在忙游戏开发,团队里的xxx师兄对我提供了很好指导,同时也督促自己变的“勤奋”了。。。个人觉得其中一个很好的习惯就是写读书笔记吧,以前自己总觉得语言类的书籍自己不用写...

代码整洁之道笔记(一)

代码整洁之道笔记(一) 今天读了代码整洁之道这本书,虽然没有读完,但是为了给你自己加深影响,也为了给自己锻炼写博文的能力,同时大家也可以从我的博文中知道整洁之道讲了那些内容,来提高自己的代码质量。...

读《代码整洁之道》笔记

1、一旦发现有更好的名称,就换掉旧的。 2、它该告诉你,它为什么会存在、做什么事、怎么用。 3、如果名称需要注释来补充,那就不算是名副其实。 4、应该指明计量对象和计量单位的名称。 5、降低代...
  • wxm6614
  • wxm6614
  • 2017年07月29日 14:39
  • 109

《代码整洁之道》(《Clean Code》)读书笔记

《代码整洁之道》(《Clean Code》)读书笔记因为想成为更好的程序员,所以我读了这本书,同时以《Clean Code》读书笔记作为我的第一篇博客,也是希望自己像书里说的那样去在意代码,时时保证代...

《代码整洁之道》读书笔记

《代码整洁之道》是Bob大叔神一样的作品,这本书从引言到附录都无比精彩,书中的插图也非常好,代码是用Java语言书写的,程序员尤其是Java程序员赶紧去阅读吧!...

代码整洁之道I--摘要(读书笔记)

一.不整洁代码的坏处: 1.赶着推出产品,代码写得乱七八糟。特性越加越多,代码也越来越烂,最后再也没法管理这些代码了。是糟糕的代码毁了这家公司。 2.随着混乱的增加,团队生产力也持续下降,趋向于零...

【读书笔记】《代码整洁之道》第4-7章

第四章——注释是啥啊? 注解的恰当用法释弥补我们在用代码表达意图时遭遇的失败 反思:就是这玩意不是好的。。你表意不清才会有的。写好注释,不如先写好代码。 如果你发现自己需要协助时,再想想看是否...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:代码整洁之道(一)——初学笔记
举报原因:
原因补充:

(最多只允许输入30个字)