美文网首页
代码命名规范

代码命名规范

作者: 土豆吞噬者 | 来源:发表于2019-08-15 22:52 被阅读0次

类名与方法名

类名和对象名应该是名词或名词短语,例如Customer,Account,避免使用Manager,Processor,Data,Info这样过于笼统的类名。方法名应当是动词或动词短语,例如postPayment,deletePage。

名副其实

代码中的命名应该名副其实,使人一眼看上去就知道是它们为什么存在,做什么事,应该怎么用,如果需要注释来补充,就不算是名副其实,一旦你发现有更好的名称就应该换掉旧的名称。

做有意义的区分

代码中的命名应该做有意义的区分,有些编译器要求同一作用域两样不同的东西不能重名,你可能随手改掉其中一个的名称,例如参数名和局部变量都为product时,修改其中一个为productInfo,它们的名称虽然不同,意思却无区别。Info,Data,Object这些后缀都是一种毫无意义的废话,要体现出有意义的区分,参数名可以用the作为前缀,局部变量名可以使用a作为前缀。废话都是冗余,例如NameString比Name就差多了,一般人都会认为Name是String,后面的String完全是废话,如果Name是其它类型,就触犯了关于误导的规则。

使用读的出来的名称

不要为了使命名变短而使用不恰当的缩写,例如generationRandomNumber就比genRandNum更好。

使用可搜索的名称

尽量使用可搜索的命名,搜索MAX_NAME_PATH很容易,搜索7就麻烦了。

避免误导

代码中的命名应该避免误导,应当避免使用与本意相悖的词,例如使用bookList来表示一组书籍,除非它真的是List类型,否则会引起错误的判断,这个时候使用bookGroup或books更好。

避免使用匈牙利命名法

在过去由于编译器不做类型检查,程序员需要使用匈牙利命名法(命名前面加类型标识)来帮助自己记住类型,而现在这种类型标识纯属多余,它们增加了修改变量,函数或类名称的难度。

相关文章

  • Android开发中的优化方案

    一、命名规范 代码规范先从命名规范开始,Android的命名规范主要涉及:Java源代码,xml文件,图片资源。 ...

  • 代码规范命名规范

    命名 项目名称,包名称,全部小写 类名驼峰命名,每个字母开头大写 变量,方法 首字母小写,其余开头大写

  • Swift--规范编程

    命名规范 注释规范 声明 代码排版 命名规范 常用命名方法 匈牙利命名,一般只是命名变量,原则是: 变量名 = 类...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码命名规范

    url 映射多单词名称时采用下划线URL通常用/list,add,delete,update 命名(查询,新增,删...

  • 代码命名规范

    类名与方法名 类名和对象名应该是名词或名词短语,例如Customer,Account,避免使用Manager,Pr...

  • 规范文档

    1.命名规范2.注释规范3.代码规范4.目录规范 1.命名规范 通用规范通用规范是在整个项目中,所有的命名都需要遵...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 天高iOS代码写作规范

    @(代码写作规范) [TOC] 一、文件名规范 命名格式 通用格式: 命名规则: Controller: 模型: ...

  • 04 | 代码规范:实践开发 Flutter 编程代码规范工具

    在实践编程之前,我们先来掌握代码规范,毕竟优秀的编程代码从规范开始。 命名规范 命名规范中包括了文件以及文件夹的命...

网友评论

      本文标题:代码命名规范

      本文链接:https://www.haomeiwen.com/subject/wsqxsctx.html