代码整洁之道 注释与格式

原创 2015年11月21日 21:03:11

人懒下来真的很容易,又有两天没更新了。

这次主要是复习注释与格式方面的内容,大多是条条款款的东西,理解起来比较容易。


关于注释:

1- 注释不能美化糟糕的代码。

代码是源头,不要本末倒置,不要夸大注释的作用。

2- 用代码来阐述。

让人看过函数名,就知道实现什么功能。

3 - 好注释

涉及法律信息(版权之类);提供代码所不包含的信息;对意图方面的描述;警示等等。

4- 坏注释

描述不清晰,说了和没说一样,或者说了让人更糊涂;描述多余,代码已体现所述容;循规式的注释,除了筹字数,真没啥意义;

日志、标记、归属、署名,这些都交给代码管理系统吧;注释掉的代码,让后续接手人迷惑,最好删除。


格式的目的:更容易的沟通,提高可维护性。

关于垂直格式:

1- 从上到下,细节逐渐增加。

2- 善用空白行,分隔不同关系集合的函数。

3-  函数排列上的靠近,取决于代码的相关度。

三个原则:调用者在被调用者之上,越相关越靠近,自上向下展示函数的调用依赖顺序。


关于横向格式:

1- 一行字符不要超过100。 (估计和作者用的显示器和编辑器有关,不用左右拉动。)

2- 分隔主要是依靠空格。

3- 水平对齐,缩进,空范围等。

格式方面没有什么太固定的要求,一切以你所在团队的要求为准。



 




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

相关文章推荐

《代码整洁之道》摘录---注释

注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。我们总无法找到不用注释就能表达自我的方法,所以总要有注释,这并不值庆贺。   如果你发现自己需要写注释,再想想看是否有办法翻盘,用代码来表达。...

代码整洁之道读书笔记--注释

注释的恰当用法是弥补我们在用代码无法表达意图是遭遇的失败。注意,我用来“失败“一次。我是说真的。我们总无法找到不用注释就能表达自我的方法,所以总要有注释,这并不值得庆贺。 程序员应当负责将注释保...

代码整洁之道-注释

代码整洁之道-注释

代码整洁之道精华——第五章 格式

阅读本文有两种原因:第一,你是个程序员;第二,你想成为更好的程序员。你如果想成为更好的程序员,那就请细细品味文章内容,它绝不会让你失望。

《代码整洁之道》摘录---格式

团队应该一致同意采用一套简单的格式规则,可以运用将这些规则自动化的工具。 代码格式关乎沟通,而沟通是专业开发者的头等大事。 或许你认为“让代码能工作”才是专业开发者的第一优先级。你今天编写...

代码整洁之道精华——第七章 错误处理

阅读本文有两种原因:第一,你是个程序员;第二,你想成为更好的程序员。你如果想成为更好的程序员,那就请细细品味文章内容,它绝不会让你失望。

读代码整洁之道

现在的软件系统开发难度主要在于其复杂度和规模,客户需求也不再像Winston Royce瀑布模型期望那样在系统编码前完成所有的设计满足用户软件需求。在这个信息爆炸技术日新月异的时代,需求总是在不停的变...

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

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

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

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

代码整洁之道

声明:本文来自网络,不知是哪位大神之作 第1章  整洁代码………………………………………………………………………………………………………………………………………………………….1 1.1  要...
  • judim
  • judim
  • 2011-09-30 11:38
  • 2369
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

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