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

原创 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.

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

相关文章推荐

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

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

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

第十三章 并发编程并发编程或者说是多线程编程,可以有效的减少系统响应时间,增加系统吞吐量。 一些关于编写并发软件的中肯说法: 1. 并发会在性能和编写额外代码上增加一些开销。 2. 正确的并发是...

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

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

(读书笔记)代码整洁之道-命名部分

代码整洁之道读书笔记有意义的命名(只是做个笔记加深记忆,并且可以时不时提醒自己) 命名应该明确它为什么存在,它能做什么事,它怎么用 达到在不用注释的情况下说明意义 避免产生误导比如可能的专有词汇,看...

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

继续整理本书的内容。第八章 边界本章主要讲了如何控制代码的边界,己方代码与第三方代码之间,不同模块之间,核心的思想是,要保证边界整洁,需要透彻的浏览和学习边界,对边界内容进行过载的测试也是值得的,同时...

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

继续本书读书笔记的整理。第五章 格式本章主要讲了代码排版方面的一些建议,当然这些只是建议,毕竟代码格式方面的东西每个公司甚至各个团队之间都可能不一样。 代码的格式说白了就是代码的风格,它跟代码的清晰...

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

《代码整洁之道》是各大编程网站都极力推荐程序员读的一本书。很遗憾准确算起来进入IT行业也算是有五年了,直到最近才把这本书读完。本来是说想也一下读书感想,毕竟以前读的社会科学的书籍时写的大多是感想。不过...

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

最初我喜欢这本书可能是因为非技术方面的原因,这本书中有很多我喜欢的插图。这本书的第一章的第一句话是这样说的:读这本书通常有两个原因:1. 你是一名程序员。2. 你想成为更好的程序员。我们需要更好的程序...

代码整洁之道读书笔记--对象和数据结构

1.得墨忒耳律(LoD) 得墨忒耳律(维基百科)认为:模块不应了解它所操作对象内部情形,对象应该隐藏数据,曝露操作,这意味着对象不应通过存取器曝露其内部结构,因为这样更像是曝露而非隐藏其内部结构。可...

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

好函数的需要满足:1. 短小: 经过漫长的试错,经验告诉我,函数就该小。 一个强制性的原则是,代码长度最好20行封顶。 2.代码块和缩进:if、else、while语句等,其中的语句只有一个,就是...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

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