离愁

悲莫悲兮生别离

代码整洁之道 注释与格式

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

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


关于注释:

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

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

2- 用代码来阐述。

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

3 - 好注释

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

4- 坏注释

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

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


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

关于垂直格式:

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

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

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

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


关于横向格式:

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

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

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

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



 




阅读更多
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/cluse/article/details/49967445
个人分类: 构架师
想对作者说点什么? 我来说一句

[精品]代码整洁之道.epub

2018年01月02日 4.55MB 下载

没有更多推荐了,返回首页

不良信息举报

代码整洁之道 注释与格式

最多只允许输入30个字

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭