代码变量命名方法和使用规范

女爷i 2023-06-08 12:56 86阅读 0赞

### 目录 ###

*  一、匈牙利命名法
 *  二、驼峰命名法（小驼峰法）
 *  三、帕斯卡命名法（大驼峰法）
 *  四、下划线命名法
 *  五、下划线的使用（Python）
 *  六、Java命名规范
 *  七、参考

# 一、匈牙利命名法 #

**1 简介**  
匈牙利命名法（Hungarian Notation），是由1972年至1981年在施乐公司工作的程序员查尔斯.西蒙尼（Charles.Simony）,此人后来成为微软的总设计师，因其祖籍是匈牙利，故有此名。

匈牙利命名法在国内之所以这么有名是因为当时微软对其推崇备至。在上世纪90年代，MFC的出现影响了一代代程序员，而MFC中各种类的命名是以匈牙利命名法命名的，再加上当时微软出了不错的书《Windows程序设计》推波助澜，而同时呢，国内UNIX编程风格氛围不强，这种命名法几乎成了国内变量命名法的标准。这就导致在现在的某些书籍或者项目中推荐使用匈牙利命名法

**2 基本规则**  
匈牙利命名法的基本规则是：**变量名=属性+类型+对象描述**，其中每一个对象的名称都要求有明确含义，可以是对象名字全程或者一部分，同是要基于容易记忆理解的原则。

**3 常用前缀**

*  **属性部分**

*  **类型部分**：类型值得是变量的类型，如整型、浮点型、字符串等。

<table> 
 <thead> 
  <tr> 
   <th align="center">前 缀</th> 
   <th align="center">类 型</th> 
   <th align="center">前 缀</th> 
   <th align="center">类 型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">数组</td> 
   <td align="center">a</td> 
   <td align="center">长整型</td> 
   <td align="center">l</td> 
  </tr> 
  <tr> 
   <td align="center">指针</td> 
   <td align="center">p</td> 
   <td align="center">布尔型</td> 
   <td align="center">b</td> 
  </tr> 
  <tr> 
   <td align="center">函数</td> 
   <td align="center">fn</td> 
   <td align="center">浮点型</td> 
   <td align="center">f</td> 
  </tr> 
  <tr> 
   <td align="center">无效</td> 
   <td align="center">v</td> 
   <td align="center">双字节</td> 
   <td align="center">dw</td> 
  </tr> 
  <tr> 
   <td align="center">句柄</td> 
   <td align="center">h</td> 
   <td align="center">字符串</td> 
   <td align="center">sz</td> 
  </tr> 
  <tr> 
   <td align="center">短整型</td> 
   <td align="center">n</td> 
   <td align="center">双精度浮点型</td> 
   <td align="center">d</td> 
  </tr> 
  <tr> 
   <td align="center">计数</td> 
   <td align="center">cnt</td> 
   <td align="center">字符</td> 
   <td align="center">ch</td> 
  </tr> 
  <tr> 
   <td align="center">整型</td> 
   <td align="center">i</td> 
   <td align="center">字节</td> 
   <td align="center">by</td> 
  </tr> 
  <tr> 
   <td align="center">字节</td> 
   <td align="center">w</td> 
   <td align="center">无符号</td> 
   <td align="center">u</td> 
  </tr> 
 </tbody> 
</table>

*  **描述部分**：用来表示该变量描述的意义，即该变量所表示的含义。

**4 例子**  
变量定义的这些描述符号可以多个同时使用，顺序一般是m\_，再指针，再简单数据类型，再其它。

`hwnd`: h类型描述，表示句柄；wnd是变量的对象描述，表示窗口，所以hwnd表示窗口句柄。

`pfnEatApple`: pfn是类型描述，表示指向函数的指针；EatApple是变量对象描述，所以pfnEatApple表示指向EatApple函数的函数指针变量。

`m_lpszStr`: m\_表示是成员变量；l表示长整型；p表示指针；sz表示的是字符串；Str是对象描述；所以m\_lpszStr的含义就是表示指向一个字符串的长指针成员变量。

# 二、驼峰命名法（小驼峰法） #

**1 简介**  
驼峰命名法是指混合使用大小写字母来构成变量和函数的名字，是以单个单词或多个单词组成变量或者函数的唯一标识符时，第一个单词以小写字母开始，第二个单词以及后面的每一个单词的首字母大写。

**2 例子**  
下面是分别用骆驼式命名法和下划线法命名的同一个函数：

`printEmployeePaychecks()；`使用了骆驼式命名法:函数名中的每一个逻辑断点都有一个大写字母来标记；

`print_employee_paychecks()；`使用了下划线法:函数名中的每一个逻辑断点都有一个下划线来标记。

# 三、帕斯卡命名法（大驼峰法） #

**1 简介**  
帕斯卡（pascal）命名法与骆驼命名法类似。只不过骆驼命名法是首字母小写，而帕斯卡命名法是首字母大写

**2 例子**

public void DisplayInfo();
    String UserName;

二者都是采用了帕斯卡命名法。在C\#中，以帕斯卡命名法和骆驼命名法居多。

# 四、下划线命名法 #

所有字母均小写，每个单词间以下划线分割，样子像 “nginx\_vip”

`m_iMyData`是一个匈牙利命名法，m\_表示它是成员变量，小写的i说明了它是个整型,后面的和帕斯卡命名相同,指示了该变量的用途

`myData`是一个骆驼命名法,它第一个单词的第一个字母小写,后面的单词首字母大写,看起来像一个骆驼

`MyData`就是一个帕斯卡命名的示例

`my_data`是一个下划线命名的示例

# 五、下划线的使用（Python） #

**1 名称前的单下划线（如：\_name）**  
用于指定属性和方法是“私有”的。但是Python不像Java一样具有私有属性、方法、类，在属性和方法之前加单下划线，只是代表该属性、方法、类只能在内部使用，是API中非公开的部分。如果用from import \* 和 from import \* 时，这些属性、方法、类将不被导入。

class Persion:
        def init(self):
            self._name="小明"

**2 名称前的双下划线（如：\_\_name）**  
以双下划线开头的方法和属性表示私有的方法和属性（可以近似这么理解，不太准确）。  
用于禁止外部访问的类成员，不能用from xx import xx导入，只有类对象可以访问

class Persion:
        def init(self):
            self.__name="小明"

**3 开头双下划线和双下划线结尾**  
特殊变量，特殊变量是可以直接访问的，不是私有变量。Python内部调用的方法，一般不建议在程序中调用。

if __name__ == '__main__':
        print('我想输出点什么')

# 六、Java命名规范 #

*  **包名**：多单词组成时，所有字母都小写：`xxxyyyzzz`。
 *  **类名、接口名**：多单词组成时，所有单词的首字母大写（大驼峰、帕斯卡命名法）：`XxxYyyZzz`。
 *  **变量名、方法名**：多单词组成时，第一个单词首字母小写，第二个单词开始的每一个单词首字母大写（小驼峰法）：`xxxYyyZzz`
 *  **常量名**：所有字母都大写，多单词时每个单词用下划线连接：`XXX_YYY_ZZZ`

# 七、参考 #

[命名方法：https://blog.csdn.net/bailang\_zhizun/article/details/82699][https_blog.csdn.net_bailang_zhizun_article_details_82699]  
[命名方法：https://www.jianshu.com/p/a8d1e05c6d68][https_www.jianshu.com_p_a8d1e05c6d68]  
[下划线使用：https://www.cnblogs.com/endmoon/p/9657838.html][https_www.cnblogs.com_endmoon_p_9657838.html]  
[下划线使用：https://www.cnblogs.com/lhrbest/p/10281563.html][https_www.cnblogs.com_lhrbest_p_10281563.html]

[https_blog.csdn.net_bailang_zhizun_article_details_82699]: https://blog.csdn.net/bailang_zhizun/article/details/82699216
[https_www.jianshu.com_p_a8d1e05c6d68]: https://www.jianshu.com/p/a8d1e05c6d68
[https_www.cnblogs.com_endmoon_p_9657838.html]: https://www.cnblogs.com/endmoon/p/9657838.html
[https_www.cnblogs.com_lhrbest_p_10281563.html]: https://www.cnblogs.com/lhrbest/p/10281563.html