整洁的代码只做一件事
优雅的代码
外表或者举止上令人愉悦的优美和雅观,令人愉悦的精致和简单
命名
名副其实,
避免误导
做有意义的区分
使用读的出来的名称
使用可搜索的名称 长名称胜宇短名称,搜得到的名称胜宇自造的名称
避免使用编码
匈牙利命名法:(不要)
由于在过去数据类型都是弱类型的,那时候编译器并不做类型检查,程序员需要匈牙利语标记法来帮助自己记住类型。
JAVA不需要类型编码就,对象是强类型的,现在编辑环境在编译开始前就可以侦测到类型错误,如果还用匈牙利命名法,会增加阅读代码的难度。
成员前缀(不要)
没有必要增加前缀和后缀这些废料,这些已经变成旧代码的标志
接口和实现
接口命名去掉废字母I,实现增加Imp
避免思维映射
明确是王道,编写其他人能理解的代码。
类名
类名和对象名应该是名称或名词短语,类名不应当用动词
方法名
方法名应当是动词或动词短语。
重载构造器时,使用描述了参数的静态工厂方法名
例如:
Complex fulcrumPoint = Complex.FromRealNumber(23.0);
通常好于
Complex fulcrumPoint =new Complex(23.0);
别扮可爱
别用笑话或者俚语
言到意到,意到言到。
每个概念对应一个词
给每个抽象概念选一个词,并且一以贯之i
别用双关语
避免同一单词用于不同目的
使用解决方案领域名称
只有程序员才会读代码,所以,尽管用计算机科学术语,算法名、模式名、数学术语。
使用解决方案领域名称,不要使用问题所涉及到领域来命名,增加阅读者对业务理解的负担。
使用源自所涉问题领域的名称、
如果不能用程序员熟悉的术语来给手头的工作命名,就采用从所涉问题领域而来的名称,至少,负责维护代码的程序员可以去请教领域专家。
优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。
与所涉问题领域更加贴近的代码,应当采用源自问题领域的名称。
添加有意义的语境
不要添加没用的语境
只要短名称足够清楚,就要比长名称好,别给名称添加不必要的语境
取好名字最难的地方在于需要良好的描述技巧和共有文化背景
与其说这是一种技术、商业或管理问题, 还不如说是一种教学问题,其结果是,这个领域内的许多人都没能学会做的很好。
充分利用重构的工具,能用更好的名字就用更好的名字。
相关推荐
FPGA A 整洁代码之 道 3- 信号命名和定义应该 明确 在设计中,我们不断的给目录、源代码、文件、函数、变量、参数、类、封包进 行命名与定义。当一件工作需要进行的次数非常之多,足以证明它是不可或缺的 基本工作。...
* 整洁代码的意义? 可读性,可维护性。 * 如何写出整洁代码? 1.只做一件事 2.不重复 3.有表达力 * 整洁代码的态度要求,要遵守的军规? 专业 和责任。让营地比你来时更干净,拒绝破窗效应。 * 写出整洁...
声明代码的层次意图,明显的细节在注释中使输/输出例进说明代码中的缺陷,使标记标记通常的意义还没处理的事情已知的法运的代码对个问题不得不采的价粗糙的解决案命名关键
详细介绍了python编码时使用的代码规则,命名规则。使代码更整洁,可读性更高。
保持代码整洁的简单方法。 受到和启发。 快速大规则 所有代码都在一个函数中 总是双引号变量 避免使用全局变量,并将其声明为readonly 始终具有可运行脚本的main()函数 始终使用set -eo pipefail :快速失败并注意...
这些应遵循整个 Android 项目以帮助我们保持整洁和统一的代码库。 :slightly_smiling_face:此文大部分来自于翻译1. 项目规范1.1 项目结构一个完整的项目,应保持下列结构:src/androidTestsrc/testsrc/commonTestsrc...
在设计中,我们不断的给目录、源代码、文件、函数、变量、参 数、类、封包进行命名与定义。当一件工作需要进行的次数非常之多, 足以证明它是不可或缺的基本工作。我们一定要知道一点,基础工作 是整个项目的基石。...
代码质量与其整洁度成正比。干净的代码,既在质量上较为可靠,也为后期维护、升级奠定了良好基础。 本文并不是代码风格指南,而是关于代码的可读性、复用性、扩展性探讨。 我们将从几个方面展开讨论: 变量 函数 ...
好的程序员写的代码,整洁而规范,视觉上自然有一种美感。空白错落有致,注释恰到好处,命名和排版遵守统一的规范。差的程序员写的代码则经常出现过长的函数,前后不一致的命名方式和排版,过深的嵌套结构,非常复杂...
这是一本关于java开发中的经常使用和必不可少的编码规范,它融合了java编程规范和代码整洁之道,还有其他公司实际开发过程中所使用的编码规范,它可以使你的开发更规范,代码更整洁。
项目名称:基于Java的Pndao框架 项目简介: Pndao是一个轻量级的MyBatis...Pndao框架能够基于开发者设定的命名约定,自动化地生成对应的SQL语句,大幅提升开发效率,减少重复劳动,同时有助于保持代码的整洁与一致性。
Python编程规范是指在使用Python编程时应遵循的一系列约定和规则。编程规范的目的是提高代码的...遵循Python编程规范可以使代码更加整洁、易读和易于维护,同时也有助于提高代码的质量和可靠性。 附件为详细的规范要求
规范中详细说明了变量命名、函数定义、注释书写、代码格式化等方面的要求,使得代码更加整洁、易于阅读和理解。 此外,Google JavaScript编码规范指南还强调了代码性能和可维护性的重要性。它提倡使用高效的数据...
除了一键接入而省去 99% 不必要的、复杂的、重复的工作外,你还可以从这个开源项目获得的内容包括:整洁的代码风格和标准的资源命名规范。MVP 架构在第三库中的最佳实践:使用者无需了解内部逻辑,通过实现接口即可...
根据 Coursera 课程获取和清理数据中的说明加载和处理 UCI HAR 数据集并创建整洁的数据集 概述 脚本“run_analysis.R”对 UCI HAR 数据集执行以下操作: 使用描述性活动名称来命名数据集中的活动 使用描述性变量...
这个原则适用于大部分的工程。...通过仔细斟酌的方法命名、清晰的流程控制,代码本身就可以拿出来当作文档使用,而且它永远不会过期。相反,注释不能让写的烂的代码变的更好。如果别人只能依靠注释读懂
《阿里巴巴Java开发手册》是一份非常重要的文档,它为Java开发者提供了一系列规范和最佳实践,帮助他们编写高质量、高效率的Java...7. **代码规范**:遵循统一的代码规范,保持代码的整洁、易读,利于团队协作和维护。
在处理新功能或任务时,请使用命名模式创建新分支: 任务/我当前的任务描述 功能/我当前的功能描述 如果您正在修正错误,请使用命名模式创建新分支: 解决/我当前的问题 错误修正/我当前的问题 再见,再见,桑德罗...
它有助于保持代码干燥,整洁和简单。 规格在Ruby 1.9.3-p125、1.9.2-p318和1.8.7-p358上通过ActiveRecord 2.3.9-2.3.14通过 有用的链接 文档: 仓库: 问题: Google: Railscast: 在直接与我联系之前...