关键词:
有意义的命名
1 名副其实
2 避免误导
3做有意义的分区
废话都是冗余。Variable永远不应出现在变量名中,Table一词永远不应出现在表名中。
当缺少明确约定:变量moneyAmout与money没区别,customerInfo与customer没区别,accountData与account没区别,theMessage与message没区别。
4 使用读得出来的名称
5 使用可搜索的名称
使用常亮代替数字会比直接使用数字更利于搜索。比如
WORK_DAYS_PER_WEEK
比数字5要好找得多,也体现出数字5的含义。
6 避免使用编码
不要使用前缀,比如
m_
这样的接口和实现
如果你做一个创建形状用的抽象方法(AbstractFactory),不要使用IShapFactory
这样的,去掉I
,直接使用ShapFactory
,直接告诉读者这是一个ShapFactory
7 避免思维映射
如for循环中,只用i,j,k,不要使用其他如
l
这样的字母明确是王道
8 类名
类名和对象名应该是名词或名词短语。
9 方法名
方法名应当是动词或动词短语。
重载构造器时,使用描述了参数的静态工厂方法名。如
Complex fulcrumPoint = Complex.fromRealNumber(23.0);
要比直接new Complex(23.0)
要好得多
10 每个概念对应一个词
给每个抽象概念选一个词,并且一以贯之。
比如,使用fetch、retriever和get给多个类中的同种方法命名。
11 别用双关语
避免将同一单词用于不同目的。
12 使用解决方案领域名称
需要给一些场景取些技术性的名称。
13 使用源自所涉问题领域的名称
如果并不能用程序员熟悉的术语解决手头的工作命名,就使用源自所涉问题领域的名称。
14 添加有意义的语境
如果某些变量是一个大结构的一部分,就把这个大结构的名称作为每部分的前缀。比如地址有国家,省份,市区。如果它们代表一个地址,就把addr添加到它们的前缀中。
当然,也不要添加没有意义的语境。
15 最后
取好名字最难的地方是需要良好的描述技巧和共有文化背景。
我们有时会害怕其他开发者反对重命名,如果讨论一下,这样的反对可能就会被消除,如果名字改的足够好,大家也会很感激你。
函数
代码整洁之道-对象和数据结构(代码片段)
现在,有一个计算面积的需求,其中一种实现如下:classSquarepublic$side;classGeometrypublicfunctionarea($shape)if($shapeinstanceofSquare)return$shape->side*$shape->side;return0; 有人看了,你这抽象的有问题啊,很明显是面向过程的,如果新加 查看详情
代码整洁之道(代码片段)
...可见命名。我们给变量、函数、参数、类和封包命名、源代码文件命名、目录命名,良好的命名规范使得代码以及工程的维护难度大大降低,下面列出良好命名的几条简单规则。1.名副其实变量、函数或类的名称应该已经... 查看详情
读《cleancode代码整洁之道》之感悟(代码片段)
盲目自信,自认为已经敲了几年代码,还看什么整洁之道啊。我那可爱的书架读懂了我的心思,很明事理的保护起来这本小可爱,未曾让它与我牵手最近项目中的bug有点多,改动代码十分吃力,每看一行代码都带一句“这是什么... 查看详情
15个书写javascript代码的整洁之道(实用!)(代码片段)
...论你是React开发者还是Node.js开发者.都能写出可以运行的代码.但是你写的代码美观并且别人能看懂吗?下面的规则可以让你的JavaScript代码更加整洁和清晰.规则1.不要使用随机的字符 查看详情
php整洁之道(代码片段)
摘录自RobertC.Martin的CleanCode书中的软件工程师的原则,适用于PHP。这不是风格指南。这是一个关于开发可读、可复用并且可重构的PHP软件指南。并不是这里所有的原则都得遵循,甚至很少的能被普遍接受。这些虽然只是指导,但是... 查看详情
代码整洁之道(cleancode)读后感(代码片段)
第二次读代码整洁之道(CleanCode)了,在少许开发经验加持下,没有第一次那么晦涩后,整体对本书也有了共鸣,这本书应该作为指导手册,平时可以多翻一翻,说不定会有新的不同感悟,当然... 查看详情
整洁架构之道--三种经典的编程范式(代码片段)
本文是《CleanArchitecture》--整洁架构之道中关于编程范式相关章节的笔记,首发于公众号「Go招聘」这和软件架构的三大关注重点不谋而合:功能性、组件独立性以及数据管理。的方式。回答此问题的同时另外还会搬出这三个词语... 查看详情
php开发-代码整洁之道(代码片段)
CleanCodePHP目录介绍变量使用见字知意的变量名同一个实体要用相同的变量名使用便于搜索的名称(part1)使用便于搜索的名称(part2)使用自解释型变量避免深层嵌套,尽早返回(part1)避免深层嵌套,尽早返回(part2)少用无意义的变量名... 查看详情
php开发-代码整洁之道(代码片段)
CleanCodePHP目录介绍变量使用见字知意的变量名同一个实体要用相同的变量名使用便于搜索的名称(part1)使用便于搜索的名称(part2)使用自解释型变量避免深层嵌套,尽早返回(part1)避免深层嵌套,尽早返回(part2)少用无意义的变量名... 查看详情
《代码整洁之道》
代码整洁之道代码猴子(CodeMonkey):低水平编码者.童子军规.技艺(craftsmanship):知和行.学写整洁代码,掌握原则和模式,并付出行动.整洁代码代码呈现了需求的细节.这些细节无法被忽略或抽象,必须要严谨,精确,规范和详细.糟糕的代码... 查看详情
架构整洁之道,看这一篇就够了!(代码片段)
阿里妹导读:程序的世界飞速发展,今天所掌握的技能可能明年就过时了,但有些知识历久弥新,掌握了它们,你在程序的海洋中就不会迷路,架构思想就是这样的知识。本文是《架构整洁之道》的读书心得,作者将书中内容拆... 查看详情
代码整洁之道源码分享(代码片段)
最近学习代码整洁之道,在练习的过程一直想找到章节中的源码案例,直接进行练习,无奈没有找到,只能自己耗时耗力的从头开始敲,总觉的讲解代码的书籍,不提供源码是可耻的,哈哈。分享链接为代码整洁之道书中部分章... 查看详情
typescript代码整洁之道
干净整洁的代码,不但质量更可靠,也为后期升级、维护打下了良好的基础。那么,整洁代码的衡量标准是什么?本文将RobertC.Martin的CleanCode思想融入到TypeScript,一起探讨研究代码整洁之道。 WTFs/Minute 1.命名的艺术计算... 查看详情
代码整洁之道读书笔记
代码整洁之道 前言如何用功 阅读大量代码 找优点和缺点第一章整洁代码不要留到以后,稍后等于永不烂代码影响生产力代码整洁性不但有关效率,还有关生存好代码 C++之父 尽量减少依赖关系,便于维护... 查看详情
整洁之道如何写出更整洁的代码(上)
如何写出更整洁的代码 代码整洁之道不是银弹,不会立竿见影的带来收益。 没有任何犀利的武功招式,只有一些我个人异常推崇的代码整洁之道的内功心法。它不会直接有效的提高你写代码的能力与速度,... 查看详情
代码整洁之道
文章目录代码整洁之道定义变量名字的时候常用的单词有意义的命名怎样写简洁的,别人一眼可以看的懂的方法方法参数越少越好注释格式别给方法返回null值我们该提炼方法中的变量还是不提炼方法中的变量?代码整洁之道定... 查看详情
读《代码整洁之道》有感
本周我开始阅读RobertC.Martin所著的《代码整洁之道》一书,希望能从中收获高效编写代码的诀窍,因为我自认为我的代码有时候比较糟糕,不太容易维护。一方面,是我没有养成良好的编程习惯;另一方面,我不太清楚什么才是... 查看详情
代码整洁之道读书笔记(ch4-ch7)(代码片段)
...象与数据结构的规范以及错误处理四个方面介绍了如何使代码变得简洁易懂。不同于上次摘抄的方法,这一次我会结合第一次个人作业的代码进行分析。第四章 注释这一章告诉我们,好的注释要满足以下三点要求:尽量避免... 查看详情