`

命名规范化的重要

 
阅读更多
    命名的规范有助于逻辑的清晰描述,好的命名,他人维护的时候,通过命名就可以了解功能的大概。

    有位大牛说:写代码应该第一是为了让别人看的,其次才是让程序顺便跑起来。

关于命名规则总结了两条:

1、当有实际场景时,用更能表达场景的词命名。

   例如:表示状态的词常用,state,status,这样的字段在状态机中也是有的。

但是在表示明确的比如价格状态,是否有库存状态,最好用price_status,inventory_status这样看起来非常直观且语言明确。

2、当定义通用方法时,用语言宽广的词命名。

   例如:有一个最近7天报表功能,定义一个查报表数据的时候,可以用daily_report这样的命名,但是考虑到这个查报表数据的方法可能在其他地方也会调用到这个数据查询,但并不一定是个报表需求。所以对于这样的方法命名为recent_orders
0
0
分享到:
评论

相关推荐

    数据治理之数仓命名规范大全.pdf

    本文将重点介绍数仓命名规范,这是数据治理中确保数据可理解性和高效利用的重要组成部分。 数据仓库(Data Warehouse,DW)是数据治理的核心,它按照特定的主题组织数据,便于分析和决策支持。数据仓库通常分为多个...

    sql server 命名规范

    以下是针对SQL Server命名规范的详细解析,旨在帮助开发者建立标准化的命名习惯。 #### 1. 基本命名规则 - **全小写或全大写**: 数据库对象如表名、列名等应统一采用全小写或全大写,以保持一致性。例如:`tbl_...

    中国联通网络资源命名规范

    整体而言,中国联通OSS网络资源命名规范为网络资源的规范化管理提供了标准化的指导,有助于提升网络资源管理的效率和准确性,同时也便于网络资源的查找、维护和升级。规范中所规定的命名方法不仅适用于中国联通内部...

    c#项目的命名规范

    ### C#项目的命名规范详解 在C#项目开发中,遵循一套统一且规范的命名约定是至关重要的。这不仅有助于提升代码的可读性和维护性,还能促进团队成员之间的沟通效率。本文将深入探讨C#项目的命名规范,涵盖WinForm和...

    PCB封装库命名规范.pdf

    在EDA电子设计自动化领域,PCB封装库的命名规范是确保电子元器件零件高效管理和正确应用的重要基础。封装库的命名规范涉及原理图模型制作标准、焊盘规范以及封装规范,它不仅有助于PCB设计者在设计电路时快速准确地...

    web前端+css命名 规范

    在Web前端开发中,CSS(层叠样式表)命名规范是至关重要的,它不仅有助于代码的可读性和可维护性,还能提升团队协作的效率。本文将深入探讨CSS命名规范及其重要性,并结合HTML和CSS的基础知识,为前端开发者提供一份...

    元件封装库命名规范

    元件封装库命名规范是电子设计自动化(EDA)领域的一项重要标准,它确保了电子元件封装数据的统一性、一致性和可读性,从而提高设计效率和可维护性。在PCB设计过程中,遵循命名规范是非常关键的,这有助于设计师、...

    PCB原理图及封装命名规范大全

    本资源“PCB原理图及封装命名规范大全”显然是一份详尽的指导文档,旨在帮助工程师遵循正确的命名规则,以确保设计的标准化和一致性。以下是对这些关键概念的深入解释。 1. **原理图规范**:原理图是电路设计的蓝图...

    java/c#/js编程命名规范

    此外,随着IDE的智能化,代码自动生成和重构工具的发展,命名规范的实施也变得更加高效和便捷。总之,良好的命名规范是高质量软件开发不可或缺的一部分,能够显著提升代码的质量和项目的成功率。

    数据库表字段命名规范

    因此,建立一套行之有效的数据库表字段命名规范显得尤为重要。 #### 数据库命名规范 - **组成元素**:使用26个英文字母(区分大小写)和0-9的自然数(通常不需要),以及下划线`_`来构成数据库名。命名应简洁明了,...

    Web网页设计命名规范

    在Web UI设计中,命名规范是非常重要的。这里列出了基本的Web UI设计命名规范: 1. Container:网站的基本结构,囊括了所有页面元素,命名可为“container”、“wrapper”、“page”等。 2. Header:网站的头部...

    数据库命名规范(通用)

    数据库命名规范是数据库管理中的重要组成部分,它不仅有助于维护数据库的整洁和一致,还能提高开发人员之间的协作效率。一个良好的命名规范应该包括表、列、索引和其他数据库对象的命名原则。这些原则应遵循行业标准...

    C#三层命名规范

    在软件开发过程中,良好的命名规范对于提高代码的可读性和维护性至关重要。特别是在采用分层架构的应用程序设计中,合理的命名不仅有助于其他开发者快速理解代码结构,还能有效减少后期维护成本。本文将详细介绍C#三...

    asp.net命名规范

    ASP.NET命名规范是编程实践中非常重要的一个方面,它有助于提高代码的可读性、可维护性和团队间的协作效率。遵循良好的命名规范可以让其他开发者更容易理解你的代码,从而降低出错的可能性,提高软件的整体质量。 ...

    史上最全的PCB封装命名规范(1).pdf

    PCB封装命名规范 PCB封装命名规范是电子行业中一个非常重要的概念,对于PCB设计和制造过程中至关...PCB封装命名规范是一个复杂的系统,需要对各种封装的命名规则进行规范化,以确保PCB设计和制造的标准化和高效化。

    数据库表命名规范

    随着项目的规模增长和业务复杂度的提升,数据库的表命名规范就显得至关重要,它不仅关系到数据的一致性和可维护性,还对团队协作产生直接影响。因此,本知识点将对数据库表命名规范进行详细解读。 首先,数据库表...

    标准规范-数据库命名规范

    数据库命名规范是数据库设计的重要组成部分,它旨在提高代码的可读性、可维护性和团队协作效率。以下是对标题和描述中所述知识点的详细说明: 1. **大小写敏感的SQL语句**:在某些数据库系统中,如MySQL和...

    flex的命名规范

    ### Flex的命名规范详解 #### 一、引言 随着Adobe Flex和ActionScript 3的发展,为了提升软件的可维护性和可读性,制定一套统一的代码编写规范变得尤为重要。良好的编码规范不仅能帮助开发人员更好地理解和协作,...

    Web UI 设计命名规范讲解

    在 Web UI 设计过程中,统一的命名规范对于团队的协作和工作效率至关重要。设计师和前端开发工程师需要通过设计效果图源文件进行合作,统一的命名规范可以使他们更好地合作和沟通。 Web UI 设计命名规范可以分为两...

    数据库表命名规范.pdf

    在数据库设计中,合理的命名规范至关重要,它不仅能够提升代码的可读性和维护性,还能帮助开发人员快速理解表结构。根据“数据库表命名规范.pdf”的描述,表名应遵循以下规则: - **复数形式**:表名应采用名词的...

Global site tag (gtag.js) - Google Analytics