代码整洁之道--格式

举报
i进击的攻城狮 发表于 2022/06/27 21:34:26 2022/06/27
【摘要】 前言写代码的时候不能仅仅关注代码功能是否完善,也应该主要代码的格式是否符合规范,或许你认为"让代码能工作"才是开发者应该考虑的头等大事,但是,如果没有好的代码格式,在以后版本的迭代和修改中,代码的可读性会对以后发生的修改行为产生深远的影响 一、垂直格式 1、自顶向下的去阅读在你看报纸的是,你会希望有个头条,告诉你报纸的主题,如何第一段是整个故事的大纲,但隐藏了具体细节,接着继续往下读,细节...

前言

写代码的时候不能仅仅关注代码功能是否完善,也应该主要代码的格式是否符合规范,或许你认为"让代码能工作"才是开发者应该考虑的头等大事,但是,如果没有好的代码格式,在以后版本的迭代和修改中,代码的可读性会对以后发生的修改行为产生深远的影响


来自《代码整洁之道》插图

一、垂直格式

1、自顶向下的去阅读

在你看报纸的是,你会希望有个头条,告诉你报纸的主题,如何第一段是整个故事的大纲,但隐藏了具体细节,接着继续往下读,细节慢慢的呈现,直到你了解整个故事发生的时间,地点等等。
报纸由很多文章组成,多数短小精湛,少数的有点长,但很少有占满一页的,如果报纸只登载一篇特别长的新闻,没人会去读它。
我们的代码也应如此,从上往下,从左往右。

2、概念上的垂直分隔

定义的函数之间,不应该紧紧挨着一起,每个函数之间做好空号分隔;

3、垂直方向向上靠近

紧密相关的代码应该相互靠近,成员变量不留空格

4、紧密关联的函数相互靠近

避免从一个函数跳到另一个函数,这样不停的跳跃。一个函数调用另一个函数,应该尽量保证被调用的函数在调用者的下面挨着,这样阅读更方便。

5、成员变量应该声明在类头部

函数的变量应该在函数开头声明,如果需要函数中声明,考虑是否函数需要拆分成多个函数执行;

二、横向格式

1、一行代码的宽度

保持行代码的短小,避免行代码超过你的屏幕,如果超过,应该考虑换行或者修改更精炼的变量名称

2、水平方向的区隔与靠近

加法、减法、乘法、赋值符合(+、-、==、=)符号直接应该加上空格,表示低优先级,乘法、除法(*、/)之间应该不加空格,表示高优先级,函数参数的逗号之后应该加上空格。

3、水平对齐没有必要

不用这样做,没有必要
在这里插入图片描述

4、代码缩进

即使代码只有一行,也应该写中括号,换行,不要节省篇幅

5、避免循环,判断语句,函数体为空

在多个if判断中,避免某一个语句里什么都不执行

总结

写完代码,最后review code,从上到下检查垂直格式,从左到右检查水平格式
【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。