`

有意义的命名

 
阅读更多

1.名副其实



 

2.避免误导

用accountGroup / bunchOfAccount 代替 accountList

 

3.做有意义的区分

 

4.使用可读的名称

 

5.使用可搜索的名称

  1.长名称比短名称好,不要单纯的字母or数字

  2.名称长短应与其作用域大小对应,变量在代码中多次出现,则应赋予可被搜索的名称

 

6.避免使用编码

 

7.命名请一以贯之,别一个概念一个单词

   

8.添加有意义的语境

例如addrState代替state,更好地方法是创建一个Address的类

例子:

 

 

 

  • 大小: 132.2 KB
  • 大小: 133.2 KB
  • 大小: 131.4 KB
  • 大小: 77.8 KB
分享到:
评论

相关推荐

    C#编程风格第三章

    对于临时变量,如果其上下文和用途已足够清晰,比如用作循环计数器或索引的变量,可以适当简化命名,不需要过于严格遵守有意义命名的原则。这样做既可以保持代码简洁,又不会影响代码的可读性。 总的来说,C#编程...

    命名管道,命名管道,命名管道

    命名管道是Windows操作...了解和掌握命名管道的原理及使用方法,对于开发Windows系统下的多进程应用具有重要意义。在实际开发中,命名管道可以与其他IPC机制,如消息队列、套接字等结合使用,以满足更复杂的应用场景。

    Verilog代码命名六大黄金规则.docx

    第一部分全部大写,第二部分所有具有明确意义的英文名全部拼写或缩写的第一个字母大写,其余部分小写。 例如:CPUMMU_WrReq,下划线左边是第一部分,代表数据方向是从CPU模块发向存储器管理单元模块(MMU)。下划线...

    c#项目的命名规范

    2. **变量命名**:局部变量应具有描述性,避免使用如`x`、`y`、`z`这样的无意义命名。 3. **注释**:关键语句和变量声明需添加注释,以解释其功能和用途。 4. **类型转换**:在C#中,推荐使用`as`关键字进行类型转换...

    喜马拉雅FM文件命名归纳.zip_feathersify_plainvoq_命名归档_喜马拉雅FM_喜马拉雅命名

    另一方面,"plainvoq"可能是一个命令行工具或者插件,专门用于处理音频文件的元数据,如提取音频标题、主播姓名等信息,以便于生成有意义的新文件名。 "命名归档"这一标签表明这个过程不仅涉及简单的重命名,还涉及...

    .NET项目命名规范

    1. **有意义的命名**:确保所有命名都有明确的意义,便于理解和维护。 2. **避免硬编码**:对于具有特定含义的数字,应使用枚举来表示,而非直接在代码中硬编码数字。 3. **枚举类型参数**:当函数参数涉及枚举类型...

    C#命名规范大家都知道写程序应该有个好的命名规范,好的命名是为了工作方便,可以方便调用控件等

    总的来说,遵循这些C#命名规范有助于编写出易于理解和维护的代码。当团队成员都遵守同一套规则时,代码一致性得到增强,减少了理解代码的时间,提高了开发效率。通过良好的命名规范,代码可以作为一种有效的沟通工具...

    DCS组态命名规则.pdf

    DCS(Distributed Control System,分布式控制系统)作为一种广泛应用在工业过程控制中的系统,其组态命名规则对于提高工作效率、减少组态工作强度、规范组态工作以及提升组态的可读性和可维护性具有重要意义。...

    C#编码命名规则,Webservice命名

    * 局部变量的名称要有意义,不要用 x、y、z 等等(循环变量除外)。 * 所有的成员变量声明在类的顶端,用一个换行把它和方法分开。 * 文件名要能反映类的内容,最好是和类同名,一个文件中一个类。 * 大括号"{"要新...

    C# 程序命名规则

    在代码中,使用有意义的变量名代替如`a`, `b`, `c`等通用符号,可以显著提高代码的可读性。 #### 13. “{”的使用 在类、方法或其他块级结构的开始处,必须使用花括号`{`。这是C#语法的基本要求。 #### 14. using...

    C++编程变量命名规范

    ### C++编程变量命名规范详解 #### 一、引言 在C++程序设计中,良好的变量命名...这些规则不仅有助于提高个人的编码效率,也对团队合作开发有着重要的意义。希望本文能为大家在C++编程过程中提供一定的指导和参考。

    快速命名文件法(快速命名文件,适用于要命名批量的有关联的文件)

    通过上述方法,你可以高效地为大量文件赋予一致且有意义的名称,极大地提升了工作效率。尤其在处理图片文件时,合理命名可以帮助我们更好地组织和检索这些视觉资料。例如,在一个摄影项目中,你可以按照拍摄日期、...

    数据库设计过程中的命名规范

    - 使用有意义的英文单词或缩写来命名表。 - 例如,若表用于存储订单信息,则可以命名为`Orders`。 3. **前缀使用**:为区分不同类型的表,可以在表名前加上特定的前缀,如`T_`。 4. **特殊情况下**:当表名由多个...

    软件编程命名规则

    1. **提高软件质量**:良好的命名规范有助于减少错误和bug的发生概率,因为清晰明了的命名可以降低误解的可能性。 2. **增强可读性和可维护性**:规范的命名可以使代码更易于阅读和理解,从而提高代码的可维护性。 3...

    C#代码命名规范

    参数命名需要遵守一定的规范,即不使用缩写,命名直观有意义,方法注释中加描述,建议全部小写。例如:bool CheckLogin(string name, string password); 七、注释规范 注释是C#代码中非常重要的一部分,它可以提高...

    PCB封装库命名规则

    通过以上介绍可以看出,PCB封装库中的命名规则遵循一定的逻辑性和系统性,每种类型的封装都有其特定的命名方式。掌握这些规则对于提高工作效率、减少错误以及促进团队合作具有重要意义。希望本文能为广大电子工程师...

    基于深度学习的古汉语命名实体识别研究.pdf

    基于深度学习的古汉语命名实体识别研究是自然语言处理领域的一个重要方向。命名实体识别是自然语言...本文的研究结果对于古汉语命名实体识别领域具有重要意义,并且为古汉语信息提取领域的发展提供了新的思路和方法。

Global site tag (gtag.js) - Google Analytics