美文网首页
代码整洁之道(整理四:格式)

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

作者: 无聊之园 | 来源:发表于2020-04-16 13:44 被阅读0次

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

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

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

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

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

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

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

相关文章

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

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

  • 代码整洁之道【4】--格式

    一、 格式的目的 格式关乎沟通,代码格式很重要,必须严肃对待,因为你现在写的代码可能以后由其他人维护。 或许你认为...

  • php代码整洁之道整理

    Clean Code PHP 目录 介绍 变量使用见字知意的变量名同一个实体要用相同的变量名使用便于搜索的名称 (...

  • [代码整洁之道]-整洁代码

    前段时间,看了代码整洁之道,顺手做了些笔记,分享给大家,和大家一起探讨整洁代码之道。 1.1要有代码 代码是我们最...

  • 代码整洁之道(整理一:变量)

    背景:上班咸鱼的实在是太无聊了!!!我都咸鱼好多天了。。。把之间看的这本书的重点整理成文章吧! 一、整洁代码 1....

  • 代码整洁之道(整理二:函数)

    背景:接上回,上回说的是变量。 1、函数不能太长。抽离方法和重命名操作,会让函数更清晰。 2、短小。函数第一条规则...

  • 代码整洁之道(整理三:注释)

    背景:接上回。上回说的是函数,这回说注释。 总结提前:注释这里能说的很简单:大部分的注释都是low的,都是无用的,...

  • TypeScript 代码整洁之道 - 格式化

    将 Clean Code 的概念适用到 TypeScript,灵感来自 clean-code-javascript...

  • 代码整洁之道-<函数>

    代码整洁之道-<函数> 代码整洁之道 一书相关读书笔记,整洁的代码是自解释的,阅读代码应该如同阅读一篇优秀的文章,...

  • 笔记链接.代码整洁之道

    本书豆瓣链接:《代码整洁之道》 第1章 整洁代码第2章 有意义的命名第3章 函数第4章 注释第5章 格式第6章 对...

网友评论

      本文标题:代码整洁之道(整理四:格式)

      本文链接:https://www.haomeiwen.com/subject/hujrvhtx.html