代码整洁之道(整理四:格式)

背景: 接上文。上文讲到注释,这里说格式。你是否经常很随意的把一个方法放到一个位置,把一个变量放到一个位置。随意的换行等等。

最好是一个团队,使用一套大家都认可代码格式规则,如果每个人随意一套规则,就会很乱!但是实现其他好像有点难。
代码格式很重要,因为代码风格关乎可读性和后期维护。

1、向报纸学习。
读报纸都是从上往下读的,读代码应该也是一样的。报纸的标题应该一目了然,代码的名称也应该一目了然,代码应该在顶部给出高层次的概念,细节应该紧随其后写在下面,往下展开。

2、概念间垂直方向上的区隔。
自上而下,每组代码行展示一个思路,思路之间空格隔开。比如:包生命、导入声明、变量声明、函数声明,都有空白隔开。

3、垂直方向上的靠近
紧密相连、相关的代码应该互相靠近。比如,看代码的时候,经常从一个函数方法跳到另一个函数方法,如果说这相关的函数就在下面,就不会因为跳来跳去跳糊涂了。所以,被调用的方法应该放在调用方法的下面。
变量声明:变量应该声明在它就近使用的地方。
概念相关的代码应该放在一起。相关性越强,彼此之间的间隔应该更短。
(我觉得,除此之外,大概念上也应该有位置的风格,比如,增、删、改应该放到代码的前面,因为这个改动小,代码量小,查询应该写在后面,因为查询的方式多、代码多、后期改动大,而且,单个查询应该放到列表查询后面,因为,列表查询可能会调用单个查询,符合垂直向上靠近的分隔。这样,当一个类的方法多的时候,你就能快速找到函数该在的位置)

4、横向距离。
一行代码应该不应该出现滚动条,但是由于每个人的字体大小不一样、屏幕大小不一样,所以,只能是一个大概!

5、团队规则
每个程序员都有自己喜欢的规则,但如果在一个团队中工作,应该团队说了算。
一组开发人员应该认同一种格式风格,每个成员都应该采用这种风格,一个软件不应该由一群对代码风格意见相左的人写的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,287评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,346评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,277评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,132评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,147评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,106评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,019评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,862评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,301评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,521评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,682评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,405评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,996评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,651评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,803评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,674评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,563评论 2 352

推荐阅读更多精彩内容

  • 一、 格式的目的 格式关乎沟通,代码格式很重要,必须严肃对待,因为你现在写的代码可能以后由其他人维护。 或许你认为...
    小北觅阅读 376评论 0 0
  • 当有人查看底层代码实现时,我们希望他们为其整洁、一致及所感知到的对细节的关注而震惊。如果在团队中工作,那么团队应该...
    gg大宇阅读 288评论 0 0
  • [TOC] 代码整洁之道-理论 前言 学习中、工作中遇到很多乱七八糟的糟糕代码,自己入门时也写过不少糟糕代码。在一...
    丁永辉Dave阅读 325评论 0 1
  • 写在前面 这本书很早就看了,但看的断断续续的。这次疫情严重,在家无聊,打游戏工作之余重新完整看一遍,算是复习吧。另...
    SingleDigit阅读 770评论 0 1
  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,032评论 0 2