代码整洁之道 注释与格式

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

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

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


关于注释:

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

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

2- 用代码来阐述。

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

3 - 好注释

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

4- 坏注释

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

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


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

关于垂直格式:

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

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

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

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


关于横向格式:

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

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

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

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



 




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

代码整洁之道内容概括

一个偶然的机会读了代码整洁之道,觉得这本书讲的很好就在网上找了一个pdf读了一下,并将里面觉得有道理的内容记录下来,作为自己以后写代码的标准和准则,并且建立起属于自己的代码风格。同时也为那些曾经困惑过...
  • jiaozhenxinaichenme
  • jiaozhenxinaichenme
  • 2017年01月03日 08:56
  • 2595

《代码整洁之道》总结和感想

花了三天时间将《代码整洁之道》的基础部分看了两遍,看完了这本书,感觉不是能力上的提升,而是思想上对整洁有个整体的把握以及一些保持整洁的小技巧。下面我先说下我对这本书的整体感觉。         我认...
  • u010210248
  • u010210248
  • 2015年01月15日 14:20
  • 1873

[代码整洁之道].(美)马丁.扫描版pdf

下载地址:网盘下载 内容简介  · · · · · · 软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关。这一点,无论是敏捷开发流派还是传统开发流派,都不...
  • cf406061841
  • cf406061841
  • 2017年07月31日 10:07
  • 490

从插图看《代码整洁之道——程序员的职业素养》

和《代码整洁之道》一样,每章的开头的插图(以下简称“主题图”)都概括了该章的主题,同时因为本书每章前的引言都是Bob自传的一部分,所以主题图常常有Bob大叔,注意他的长相。每章的主题图也都隐藏了“KO...
  • dongfeng9ge
  • dongfeng9ge
  • 2017年04月29日 17:17
  • 815

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

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

【《代码整洁之道》精读与演绎】之三 整洁代码的函数书写准则

原文地址:http://blog.csdn.net/poem_qianmo/article/details/52204224 这篇文章,是关于整洁代码函数书写的一些准则。 ...
  • u012309913
  • u012309913
  • 2016年08月15日 10:03
  • 281

什么是好代码-代码整洁之道阅读笔记

根据我所阅读的书《代码整洁之道》里的一句话: “衡量代码质量的唯一有效标准: WTF/min”从哲学的角度讲,不得不说这真的很客观!!! 毕业不久的我也没有太多关于好代码的定义。应该说没...
  • wjb617882976
  • wjb617882976
  • 2016年11月23日 01:06
  • 615

【《代码整洁之道》精读与演绎】之一 让代码比你来时更干净

“我们就是一群代码猴子,上蹿下跳,自以为领略了编程的真谛。可惜当我们抓着几个酸桃子,得意洋洋坐到树枝上,却对自己造成的混乱熟视无睹。那堆“可以运行”的乱麻程序,就在我们的眼皮底下慢慢腐坏。” ...
  • zhmxy555
  • zhmxy555
  • 2016年07月31日 19:00
  • 16490

【《代码整洁之道》精读与演绎】之二 高质量代码的命名法则

本文与大家聊一聊编程中非常关键的一个点,如何更好的对代码命名。先放出这篇文章所涉及内容知识点的一张思维导图,就开始正文。大家若是疲于阅读文章正文,直接看这张图,也是可以Get到本文的主要知识点的大概。...
  • zhmxy555
  • zhmxy555
  • 2016年08月07日 19:00
  • 22779

《代码整洁之道》读后感

老实说, 像我这种工作了六七年的程序员看这种代码规范的书说出来是有点难为情的, 不怎么合适。 这种书籍应该是那些工作了四五年的程序员所应该阅读的, 但是很可惜, 我工作四五年的时候没有一个好的机会去...
  • liu_jie_1
  • liu_jie_1
  • 2017年04月23日 15:24
  • 249
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:代码整洁之道 注释与格式
举报原因:
原因补充:

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