`
sunxboy
  • 浏览: 2877926 次
  • 性别: Icon_minigender_1
  • 来自: 武汉
社区版块
存档分类
最新评论

15 个变量和方法命名的最佳实践

 
阅读更多

15 个变量和方法命名的最佳实践

  1. 在每个代码范围内使用足够短和足够长的名称:例如循环计算器用一个字符就可以了,如i;条件和循环变量用一个单词,方法名1-2个单词,类名2-3个单词,全局变量3-4个单词组成
  2. 为变量指定一些专门名称,不要使用例如 "value", "equals", "data" 这样的变量名
  3. 变量名要使用有意义的名称,通过变量名能大概反映出其具体的用途
  4. 不要在变量名前加前缀,例如 o_, obj_, m_ 之类
  5. 服从公司命名规范,在命名时使用一致的做法,例如:txtUserName, lblUserName, cmbSchoolType, ... 除非是大大降低了可读性
  6. 服从编程语言本身的规范,不要使用不连贯的小写和大写混合名称,例如:userName, UserName, USER_NAME, m_userName, username, ...
    1.  
      • 类名使用驼峰命名方式,如:VelocityResponseWriter
      • 包名小写:net.oschina.beans.xxx
      • 变量名小写开始的驼峰命名,例如:studentParentName
      • 常量名用全大写:MAX_PARAMETER_COUNT = 100
      • 枚举类名参考普通类名,枚举变量使用全大写
      • 不使用任何带下划线的命名方式(OSCHINA项目大量采用带下划线的变量,哈哈),除非是常量或者是枚举值
    • 对 Java 而言:
  7. 不要在同一个类的不同上下文中重用相同的变量名
  8. 不要在一个方法内用同一个变量做不同的用途
  9. 不要使用非 ASCII 字符的变量,例如中文变量
  10. 不要使用太长的变量名,例如50个字符,这很难阅读,而且可能超出一些编译器的限制
  11. 确定并坚持使用固定的一种自然语言的命名方式,例如不要使用拼音和英文混合的命名方式
  12. 方法名要使用有意义的名称,能通过方法名大概了解该方法的用途,而且方法名要以动词开始,例如createPasswordHash
  13. 方法名要符合公司统一的规范,例如:getTxtUserName(), getLblUserName(), isStudentApproved()
  14. 方法名要遵循编程语言规范
  15. 方法的参数名要使用有意义的名称
分享到:
评论

相关推荐

    C语言变量命名规则

    2. **变量命名的约定和最佳实践**: - 变量名应具有描述性,反映其存储的数据类型或用途。例如,用`firstName`表示一个人的名字。 - 遵循驼峰命名法或下划线命名法。驼峰命名法如`firstName`,下划线命名法如`...

    Python中的变量用法和最佳实践指导

    涵盖的内容包括创建和赋值变量、变量的数据类型动态变化、在表达式和各种编程情境中使用变量(如计数器、累加器、临时变量、布尔标志、循环变量和数据存储变量),以及变量命名的最佳实践。文章还探讨了变量的作用域...

    C语言变量名命名规则

    3. **长度限制**:虽然大多数编译器允许变量名长度超过255个字符,但为了兼容性和最佳实践,通常建议保持变量名的长度适中,一般不超过30个字符。 4. **大小写敏感**:C语言是大小写敏感的,因此"myVariable"和...

    自主创作的代码编写变量命名工具

    标题中的“自主创作的代码编写变量命名工具”指的是一个由个人开发者设计...通过这个工具,用户可以更方便地遵循最佳实践,提升代码质量和一致性。同时,提供的使用说明和图标文件增强了用户体验,使得该工具更加易用。

    QT 使用全局变量的方法 - 郭小郭的专栏 - CSDN博客1

    ### 考虑因素和最佳实践 1. **封装**:尽量避免全局变量,因为它们可以使代码的依赖关系变得模糊,导致难以理解和维护。 2. **内存管理**:全局变量的生命周期始于程序启动,结束于程序结束,可能导致资源泄漏。 3....

    JavaScript声明全局变量访问方法

    - **作用域冲突**:全局变量可能会导致命名冲突,尤其是在大型项目中,多个模块可能无意间使用相同的全局变量名称,从而引发错误。 - **内存消耗**:全局变量在整个程序生命周期内都存在,会占用内存资源,因此不...

    MFC.rar_变量命名

    综上所述,MFC中的变量命名应当清晰、一致且符合C++的最佳实践。遵循这些规则,不仅可以帮助个人更好地理解和维护代码,也能促进团队间的有效合作。文档如《MFC中变量的命名方法.docx》可能提供了更详细的指导,建议...

    如何给变量命名

    本文将基于给定文件的信息,深入探讨.NET框架下的变量命名规则与最佳实践。 #### 基本原则 1. **使用英文字符**:标识符(包括变量、常量、枚举、函数、类、接口、命名空间等)应只包含英文大小写字母和数字,避免...

    WINCC组态中结构变量的使用

    在探讨西门子WINCC 6.2版本的SCADA软件中如何运用结构变量组态画面模板之前,我们先简要回顾一下结构变量的基本概念及其在工业...对于那些需要处理大量相似设备参数的工业项目而言,这种组态方法无疑是最佳实践之一。

    VC变量命名规范(有例子)

    4. **定期审查**:定期审查代码并更新变量命名,确保它们仍然符合当前的需求和最佳实践。 #### 五、总结 Microsoft为Windows编程提供了一套详尽的变量命名规范,这些规范有助于提高代码的质量和可维护性。通过遵循...

    Shell 脚本编程最佳实践.doc

    Shell 脚本编程最佳实践主要关注代码的可读性、规范性和维护性。以下是一些关键要点: 1. **Shebang(蛇棒)**:脚本的第一行应包含`#!`,后接解释器路径,如`#!/bin/bash`。这指定了脚本应该由哪个shell解释器执行...

    .net官方编码方法和命名规则

    .NET 编码方法和命名规则是软件开发中的关键实践,它们直接影响到代码的可读性和维护性。良好的编码规范能够帮助团队成员更好地理解和协作,同时也有助于减少误解和错误。下面将详细介绍这些规则。 首先,命名是...

    labview功能性全局变量的详细使用

    6. **最佳实践** - 尽量减少全局变量的数量,因为它们增加了程序的复杂性和耦合度。 - 使用清晰的命名规范,以便其他开发者能快速理解全局变量的作用。 - 避免在循环内频繁修改全局变量,这可能导致性能下降。 -...

    变量命名规则(Python)

    在Python编程语言中,变量命名规则是编程规范的重要组成部分,它直接影响到代码的可读性和易维护性。以下是对Python变量命名规则的详细说明: 1. **弱类型特性**: Python是一种弱类型语言,这意味着在声明变量时...

    javascript最佳实践

    JavaScript最佳实践是一个广泛而深入的话题,它涉及到代码的可读性、可维护性、性能优化以及遵循良好的编程习惯。在JavaScript开发中,遵循最佳实践能够提高代码质量,降低出错概率,同时也便于团队协作和长期项目的...

    PHP+核心技术与最佳实践.pdf

    在进行这部分内容的生成时,我可以依照这些推测来介绍PHP的核心技术和最佳实践的相关知识点。 PHP是一种流行的开源服务器端脚本语言,尤其在Web开发领域广泛使用。它以其简洁明了的语法、与HTML的天然结合和良好的...

    PDI Kettle 最佳实践

    PDI Kettle 最佳实践是对Pentaho Data Integration(PDI)中Kettle工具应用的高级指导,旨在帮助用户更高效地完成ETL(提取、转换和加载)任务。PDI Kettle是Pentaho套件中用于ETL的组件,广泛应用于数据整合、数据...

    java命名规范java的命名规范java的命名规范java的命名规范

    15. **变量名**:采用驼峰命名法,首个单词小写,后续单词首字母大写,如 `myVar`。 **编码规约**: 2.1 **一般规约**: - **接口优先**:尽量通过接口引用对象,而不是具体的实现类。 - **避免使用不推荐的API*...

    Activiti 学习笔记五:流程变量

    8. **最佳实践**:在实际应用中,推荐使用命名规范,清晰地标识每个变量的用途,避免变量名冲突。同时,利用 Activiti 的事件和监听器机制,可以实现在特定时刻自动处理变量,增强流程的灵活性。 通过以上知识点,...

    变量、函数、类的命名规则

    变量、函数和类是程序设计中的基础元素,它们的命名规则直接关系到代码的可读性和可维护性。在阅读《Clean Code》这本书时,作者强调了命名的重要性,并提出了一系列关于命名的建议。以下将详细阐述这些命名规则。 ...

Global site tag (gtag.js) - Google Analytics