软件开发中常见的命名规范有哪些？

OS Devp Consultant

于 2024-07-26 10:11:48 发布

阅读量1.3k

点赞数 19

文章标签：代码规范

本文链接：https://blog.csdn.net/qq_33739887/article/details/140708165

版权

在软件开发中，有多种命名规则，具体使用哪种规则通常取决于团队的编码规范、编程语言的习惯以及具体的场景需求。

我发现没有找到讲解这些内容的blog，所以在这里我简单提一下吧，以下是几种常见的命名规则及其例子和解释：

1. 匈牙利命名法（Hungarian Notation）

这种命名法在变量名前面加上类型或作用的前缀，以表示变量的类型或用途。

示例：

iCount （整数变量）
strName （字符串变量）
pData （指针变量）

解释：前缀 i 表示整数，str 表示字符串，p 表示指针。这样做有助于在阅读代码时快速了解变量的类型。

2. 驼峰命名法（CamelCase）

这种命名法将多个单词连在一起，第一个单词首字母小写，后续单词首字母大写。

示例：

firstName
lastName
totalCount

解释：驼峰命名法在变量名、函数名中很常见，使得名字在视觉上容易区分单词。

3. 帕斯卡命名法（PascalCase）

这种命名法类似于驼峰命名法，但所有单词的首字母都大写。

示例：

FirstName
LastName
TotalCount

解释：帕斯卡命名法通常用于类名、接口名等，使得名称更具标识性和正式感。

4. 蛇形命名法（Snake_Case）

这种命名法使用下划线分隔单词，所有字母小写。

示例：

first_name
last_name
total_count

解释：蛇形命名法常用于数据库字段名、配置文件等，便于在不区分大小写的环境中使用。

5. 大写蛇形命名法（SCREAMING_SNAKE_CASE）

这种命名法使用下划线分隔单词，所有字母大写。

示例：

FIRST_NAME
LAST_NAME
TOTAL_COUNT

解释：大写蛇形命名法常用于常量名，使得常量在代码中显得更为突出。

6. 匈牙利命名法的变体（Apps Hungarian）

这种命名法强调变量的逻辑类型或用途，而不是具体的数据类型。

示例：

strUserName （用户名称）
arrUserList （用户列表）
btnSubmit （提交按钮）

解释：这种变体强调了变量的逻辑用途，而不是物理类型，更适合于面向对象编程。

7. 面向对象命名法（Object-Oriented Naming）

这种命名法用于对象和类，强调角色和行为。

示例：

Customer （类名）
OrderProcessor （类名）
getCustomerDetails （方法名）

解释：这种命名法通过名称传达对象的角色和方法的行为，使得代码更加易读和可维护。

8. 简写命名法（Abbreviation Naming）

这种命名法通过使用缩写来减少名称的长度。

示例：

btn （button）
lbl （label）
txt （text）

解释：缩写命名法在需要简短名称的情况下使用，但需要确保缩写的意义明确。

9. 前缀命名法（Prefix Naming）

这种命名法在变量名前添加前缀以表示其作用域或模块。

示例：

mName （成员变量，m 表示 member）
gTotalCount （全局变量，g 表示 global）
sErrorCode （静态变量，s 表示 static）

解释：前缀命名法有助于在代码中快速识别变量的作用域和生命周期。

10. 后缀命名法（Suffix Naming）

这种命名法在变量名后添加后缀以表示其类型或用途。

示例：

nameStr （字符串类型）
countInt （整数类型）
dataArr （数组类型）

解释：后缀命名法通过名称后缀传达变量的类型信息，使得代码更具自解释性。

综合示例

public class Customer
{
    private string strFirstName;
    private string strLastName;
    private int iAge;

    public Customer(string firstName, string lastName, int age)
    {
        this.strFirstName = firstName;
        this.strLastName = lastName;
        this.iAge = age;
    }

    public string GetFullName()
    {
        return $"{strFirstName} {strLastName}";
    }

    public int GetAge()
    {
        return iAge;
    }
}