首页 > 其他分享 >变量和方法命名的最佳实践

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

时间:2023-08-24 14:22:06浏览次数:29  
标签:例如 名要 变量 最佳 使用 命名 变量名

  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, ...
    • 对 Java 而言:
      • 类名使用驼峰命名方式,如:VelocityResponseWriter
      • 包名小写:net.oschina.beans.xxx
      • 变量名小写开始的驼峰命名,例如:studentParentName
      • 常量名用全大写:MAX_PARAMETER_COUNT = 100
      • 枚举类名参考普通类名,枚举变量使用全大写
      • 不使用任何带下划线的命名方式(OSCHINA项目大量采用带下划线的变量,哈哈),除非是常量或者是枚举值
  7. 不要在同一个类的不同上下文中重用相同的变量名
  8. 不要在一个方法内用同一个变量做不同的用途
  9. 不要使用非 ASCII 字符的变量,例如中文变量
  10. 不要使用太长的变量名,例如50个字符,这很难阅读,而且可能超出一些编译器的限制
  11. 确定并坚持使用固定的一种自然语言的命名方式,例如不要使用拼音和英文混合的命名方式
  12. 方法名要使用有意义的名称,能通过方法名大概了解该方法的用途,而且方法名要以动词开始,例如createPasswordHash
  13. 方法名要符合公司统一的规范,例如:getTxtUserName(), getLblUserName(), isStudentApproved()
  14. 方法名要遵循编程语言规范
  15. 方法的参数名要使用有意义的名称 
  16. List定义的变量应该 List 作为后缀结尾。

    Map定义的变量应该 Map 作为后缀结尾。

    数组定义的变量应该 s 作为后缀结尾。

标签:例如,名要,变量,最佳,使用,命名,变量名
From: https://www.cnblogs.com/phpyangbo/p/17654021.html

相关文章

  • 避免变量遮蔽
    在Go编程中,正确的代码组织和结构对于保持代码的可读性和维护性至关重要。然而,一些常见的陷阱和错误经常会影响我们的代码质量。本文将探讨如何避免变量遮蔽和滥用嵌套代码,以提升Go代码的可读性和健壮性。避免变量遮蔽的问题变量遮蔽是指在内部块中重新声明一个已存在的变量名,这......
  • 多元时间序列 | Matlab粒子群算法优化深度置信网络(PSO-DBN)多变量时间序列预测
    ✅作者简介:热爱科研的Matlab仿真开发者,修心和技术同步精进,matlab项目合作可私信。......
  • 使用条件变量模拟消费者和生产者
    题目简介生产者和消费者问题是一个经典的多线程同步问题,涉及到一个共享的缓冲区,生产者将数据放入缓冲区,消费者从缓冲区中取出数据。问题的关键是要确保生产者和消费者之间的正确交互,避免生产者在缓冲区满时继续生产,消费者在缓冲区空时继续消费。解决方案使用条件变量是一种常见的解......
  • 精选六款最佳 GraphQL 开发工具推荐
    GraphQL工具本文章,会列举一些好用的 GraphQL 工具,他们可以大大提升你在开发中使用GraphQL的效率哦!Prisma你可以这么理解,Prisma是一个ORM的库,让你使用GraphQL查询时,可以使用对象的形式去查询,而不需要使用查询语句去查询,非常方便,而且Prisma还拥有以下特点:Prisma支持很多......
  • 使用 OpenAI GPT 模型的最佳实践
    推荐:使用NSDT场景编辑器助你快速搭建可二次编辑的3D应用场景为了帮助用户获得最佳输出,OpenAI提供了使用GPT模型的最佳实践。这来自体验,因为许多用户不断尝试使用此模型并找到了最有效的方法。在本文中,我将总结使用OpenAIGPT模型应了解的最佳实践。这些做法是什么?让我们进......
  • Swift-基础语法之变量&常量&元组
    使用 let来声明一个常量,用 var来声明一个变量。常量的值在编译时并不要求已知,但是你必须为其赋值一次。这意味着你可以使用常量来给一个值命名,然后一次定义多次使用varmyVariable=42myVariable=50letmyConstant=42常量或者变量必须拥有和你赋给它们的值相同的类型。不......
  • Swift - 基本数据类型,及常/变量声明
    用oc编码已经有段时间了,这期间一直在使用oc和学习oc的编码技巧,忽闻小伙伴说:swift已经是趋势了,有时间多看看吧所以我也开始从网上搜索博客,感谢hangge.com的博客,如有冒犯之处,请多见谅,因为是看着大神的博客开始swif全面的学习之路!方向已定,无论前面有多难,都要走下去! 一、swift中基本的......
  • 多页面应用(MPA)开发最佳实践
    缘由平常开发当中,一般使用vue-cli2或vue-cli3脚手架来进行开发,默认构建出来的应用是单页面应用程序(SPA)。面对一个工程下面只有一个应用的项目,这样做是没有问题的,而面对实际开发中多个页面的需求时,就会有它局限性。比如一个项目中分为Mobile端和PC端,如果采用单页面模式构建的话,......
  • Windows修改环境变量的两种方式
    Windows环境永久修改环境变量命令行方式简单使用变量名不区分大小写1.设置用户变量setx"KEY""VALUE"2.设置全局变量setx"KEY""VALUE"/m3.追加Pathsetx"PATH""%PATH%;D:\ProgramFiles\"4.删除变量变量置空值,实际上变量仍然保存在注册表里setx"......
  • 相关依赖及命名规范
    <?xmlversion="1.0"encoding="UTF-8"?><projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache......