`
- 浏览:
529137 次
- 性别:
- 来自:
北京
-
15 个变量和方法命名的最佳实践
- 在每个代码范围内使用足够短和足够长的名称:例如循环计算器用一个字符就可以了,如i;条件和循环变量用一个单词,方法名1-2个单词,类名2-3个单词,全局变量3-4个单词组成
- 为变量指定一些专门名称,不要使用例如 "value", "equals", "data" 这样的变量名
- 变量名要使用有意义的名称,通过变量名能大概反映出其具体的用途
- 不要在变量名前加前缀,例如 o_, obj_, m_ 之类
- 服从公司命名规范,在命名时使用一致的做法,例如:txtUserName, lblUserName, cmbSchoolType, ... 除非是大大降低了可读性
- 服从编程语言本身的规范,不要使用不连贯的小写和大写混合名称,例如:userName, UserName, USER_NAME, m_userName, username, ...
-
- 类名使用驼峰命名方式,如:VelocityResponseWriter
- 包名小写:net.oschina.beans.xxx
- 变量名小写开始的驼峰命名,例如:studentParentName
- 常量名用全大写:MAX_PARAMETER_COUNT = 100
- 枚举类名参考普通类名,枚举变量使用全大写
- 不使用任何带下划线的命名方式(OSCHINA项目大量采用带下划线的变量,哈哈),除非是常量或者是枚举值
- 不要在同一个类的不同上下文中重用相同的变量名
- 不要在一个方法内用同一个变量做不同的用途
- 不要使用非 ASCII 字符的变量,例如中文变量
- 不要使用太长的变量名,例如50个字符,这很难阅读,而且可能超出一些编译器的限制
- 确定并坚持使用固定的一种自然语言的命名方式,例如不要使用拼音和英文混合的命名方式
- 方法名要使用有意义的名称,能通过方法名大概了解该方法的用途,而且方法名要以动词开始,例如createPasswordHash
- 方法名要符合公司统一的规范,例如:getTxtUserName(), getLblUserName(), isStudentApproved()
- 方法名要遵循编程语言规范
- 方法的参数名要使用有意义的名称
分享到:
Global site tag (gtag.js) - Google Analytics
相关推荐
第11章推荐并分析诸多实用的代码分析(静态和动态)的工具、技术和方法。第12章综合介绍多种商业的及开源的测试框架和工具。第四部分(第13章)告诉你如何说服对采用最佳实践存在反感和偏见的组织和个人。本书还附有...
第11章推荐并分析诸多实用的代码分析(静态和动态)的工具、技术和方法。第12章综合介绍多种商业的及开源的测试框架和工具。第四部分(第13章)告诉你如何说服对采用最佳实践存在反感和偏见的组织和个人。本书还附有...
子程序和变量 内置函数 键和索引 运算符 分号 逗号 代码行的长度 缩排 制表符 块 组块 Else 垂直对齐 断开长行 非末端表达式 按优先级断开 赋值运算 三元运算符 列表 自动化部署 第三章 命名惯例 标识符 布尔值 引用...
子程序和变量 内置函数 键和索引 运算符 分号 逗号 代码行的长度 缩排 制表符 块 组块 Else 垂直对齐 断开长行 非末端表达式 按优先级断开 赋值运算 三元运算符 列表 自动化部署 第三章 命名惯例 标识符 布尔值 引用...
因此,本文详细阐述了Java中变量、类、接口、方法、常量以及包的命名规范,并通过丰富的示例来展示如何在实际编程中遵循这些规范。希望通过本文的介绍,能够帮助读者更加深入地理解Java代码命名规范,并在实际的软件...
命名参数允许你通过参数名来传递值,这使得函数调用更加清晰,尤其是当函数有多个参数时。 function sendEmail(string $to, string $subject, string $body): void { // 发送邮件逻辑 } sendEmail(to: 'example@...
通过保持格式一致、避免多余字符、注意变量命名、理解代码逻辑以及使用代码片段管理工具等方法,我们可以更有效地剪切粘贴代码,并提高在PTA平台上的编程效率和准确性。希望本文的建议和最佳实践能对大家在PTA平台上...
本文介绍PowerShell自定义函数在使用时的最佳实践(Best Practices)。包括函数名的命名、可选参数、必选参数等。 PowerShell中的函数定义可以很简单的使用一个“function <函数名>{函数体}”的形式去定义。但...
类型名称和方法名称使用PascalCasing书写方法参数和局部变量使用camelCasing书写禁止使用匈牙利标记法或者在标识符前面增加类型标识禁止使用大写标识常量或者只读型变量避免使用缩写。例外情况:常用名称的缩写,如...
20.8 指导原则和最佳实践 20.8.1 善用finally块 20.8.2 不要什么都捕捉 20.8.3 得体地从异常中恢复 20.8.4 发生不可恢复的异常时回滚部分完成的操作——维持状态 20.8.5 隐藏实现细节来维系契约 20.9 未处理...
Airbnb的Swift风格指南提供了一套规范和最佳实践,帮助开发者编写清晰、一致和易于维护的Swift代码。这个指南涵盖了从命名约定到代码结构的各个方面,以下是关于这个资源的描述: 指南内容: 1. **命名约定**:...
4 最佳实践和禁忌 11 4.1 每次保存的时候,都让你的代码是最美的 11 4.2 使用log而不是System.out.println() 11 4.3 每个if while for等语句,都不要省略大括号{} 11 4.4 善用TODO: 12 4.5 在需要留空的地方放一个空...
20.8 指导原则和最佳实践 20.8.1 善用finally块 20.8.2 不要什么都捕捉 20.8.3 得体地从异常中恢复 20.8.4 发生不可恢复的异常时回滚部分完成的操作——维持状态 20.8.5 隐藏实现细节来维系契约 20.9 未处理...
20.8 指导原则和最佳实践 20.8.1 善用finally块 20.8.2 不要什么都捕捉 20.8.3 得体地从异常中恢复 20.8.4 发生不可恢复的异常时回滚部分完成的操作——维持状态 20.8.5 隐藏实现细节来维系契约 20.9 未处理的...
20.8 指导原则和最佳实践 20.8.1 善用finally块 20.8.2 不要什么都捕捉 20.8.3 得体地从异常中恢复 20.8.4 发生不可恢复的异常时回滚部分完成的操作——维持状态 20.8.5 隐藏实现细节来维系契约 20.9 未处理...
(Identifiers)命名习惯标识符用于定义实体名 结构体名 信号和变量名等 选择有意义的命名对设计是十分重要的命名包含信号或变量诸如出处有效状态等基本含义 下面给出一些命名的规则
谭浩强教授创造了3个世界纪录:(1)20年来他(及和他人合作)共编著出版了130本计算机著作,此外主编了250多本计算机书籍,是出版科技著作数量最多的人。(2)他编著和主编的书发行量超过4500万册,是读者最多的...
本书内容涵盖了编码风格、编程技巧、自动化、测试等几方面,既包括具体风格和原则的介绍,也包括示例和技巧说明,最后还介绍了如何通过自动化的工具和方法来实现一致的编程风格。 《编写可维护的JavaScript》作者...