编程语言命名规则及Python常用命名习惯

傷城~ 2023-05-29 05:06 4阅读 0赞

### 前言 ###

现在有很多语言，但是在编程时有良好的命名习惯，代码易读，而且对代码调试和维护都有巨大好处。一般程序员不使用诸如`ThisVariableIsATemporaryCounter`这样“聪明”的名字。程序员常用`tmp`，这写起来更简单，也不会更难懂。  
然而，当面对复杂情况时就有些棘手，给全局变量取一个描述性的名字是必要的。把一个全局函数叫做`foo`是一种目光短浅的行为。全局函数也一样，如果你有一个统计当前用户个数的函数，应当把它命名为`count_active_user()`或者简单点些的类似名称，不应该命名为`cntusr()`。

### 四种流行的命名法则 ###

目前，业界共有四种命名法则：驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法，其中前三种是较为流行的命名法。

##### 1. 驼峰命令法 #####

正如它的名称所表示的那样，是指混合使用大小写字母来构成变量和函数的名字。例如，下面是分别用骆驼式命名法和下划线法命名的同一个函数：  
`printEmployeePaychecks();`

此函数名使用了驼峰命名法，函数名中的每一个逻辑断点都有一个大写字母来标记。驼峰命名法近年来越来越流行了，在许多新的函数库和Microsoft Windows这样的环境中，它使用得当相多。另一方面，下划线法是C出现后开始流行起来的，在许多旧的程序和UNIX这样的环境中，它的使用非常普遍。

##### 2.匈牙利命名法 #####

广泛应用于象Microsoft Windows这样的环境中。Windows 编程中用到的变量(还包括宏)的命名规则为匈牙利命名法，这种命名技术是由一位能干的 Microsoft 程序员查尔斯-西蒙尼(Charles Simonyi) 提出的。

匈牙利命名法通过在变量名前面加上相应的小写字母的符号标识作为前缀，标识出变量的作用域、类型等。这些符号可以多个同时使用，顺序是先`m_(成员变量)、再指针、再简单数据类型、再其它`。这样做的好处在于能增加程序的可读性，便于对程序的理解和维护。

例如：`m_lpszStr`, 表示指向一个以0字符结尾的字符串的长指针成员变量。  
匈牙利命名法关键是：标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。

##### 3.帕斯卡(pascal)命名法 #####

与驼峰命名法类似，二者的区别在于：驼峰命名法是首字母小写，而帕斯卡命名法是首字母大写，如：  
`DisplayInfo();`  
`string UserName;`  
二者都是采用了帕斯卡命名法。在C\#中，以帕斯卡命名法和骆驼命名法居多。

##### 4. 下划线命名法： #####

另一种流行的命名规则称为下划线命名法。下划线法是随着C语言的出现流行起来的，在UNIX/LIUNX这样的环境，以及GNU代码中使用非常普遍。现在比较火的python大多也是采用下划线命名。  
`print_employee_paychecks();`  
此函数名使用了下划线法，函数名中的每一个逻辑断点都有一个下划线来标记。

##### 5. 三种命名规则的小结 #####

MyData就是一个帕斯卡命名的示例；myData是一个驼峰命名法,它第一个单词的第一个字母小写,后面的单词首字母大写,看起来像一个骆驼；iMyData是一个匈牙利命名法,它的小写的i说明了它的型态，后面的和帕斯卡命名相同，指示了该变量的用途。

### 命名的基本原则 ###

1.  标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解——尽量采用采用英文单词或全部中文全拼表示，若出现英文单词和中文混合定义时，使用连字符“\_”将英文与中文割开。较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。例如：`temp->tmp、flag->flg、statistic->stat、increment->inc、message->msg`等缩写能够被大家基本认可。
2.  命名中若使用特殊约定或缩写，则要有注释说明。应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。
3.  自己特有的命名风格，要自始至终保持一致，不可来回变化。个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。(即命名规则中没有规定到的地方才可有个人命名风格)。
4.  对于变量命名，禁止取单个字符(如i 、j 、k… )，建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i 、j 、k 作局部循环变量是允许的。变量，尤其是局部变量，如果用单个字符表示，很容易敲错(如i写成j)，而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。
5.  除非必要，不要用数字或较奇怪的字符来定义标识符。
6.  命名规范必须与所使用的系统风格保持一致，并在同一项目中统一。
7.  在同一软件产品内，应规划好接口部分标识符(变量、结构、函数及常量)的命名，防止编译、链接时产生冲突。对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。
8.  用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。  
    下面是一些在软件中常用的反义词组。

add / remove               begin / end            create / destroy
    insert / delete            first / last           get / release
    increment / decrement      put / get			  up / down
    add / delete        	   lock / unlock       	  open / close
    min / max          		   old / new              start / stop
    next / previous   		   source / target        show / hide
    send / receive    		   source / destination	  cut / paste

示例：

int  min_sum;
    int  max_sum;
    int  add_user( BYTE *user_name );
    int  delete_user( BYTE *user_name );

### Python常用命名规则 ###

##### 1. python命名限制 #####

Python 语言的标识符必须以字母、下画线`_`开头，后面可以跟任意数目的字母、数字和下画线`_`。此处的字母并不局限于 26 个英文字母，可以包含中文字符、日文字符等。

由于 Python 3 支持 UTF-8 字符集，因此 Python 3 的标识符可以使用 UTF-8 所能表示的多种语言的字符。Python 语言是区分大小写的，因此 abc 和 Abc 是两个不同的标识符。

Python 2.x 对中文支持较差，如果要在 Python 2.x 程序中使用中文字符或中文变量，则需要在 Python 源程序的第一行增加“\#coding:utf-8”，当然别忘了将源文件保存为 UTF-8 字符集。

> 在使用标识符时，需要注意如下规则：  
> 标识符可以由字母、数字、下画线（\_）组成，其中数字不能打头。  
> 标识符不能是 Python 关键字，但可以包含关键字。  
> 标识符不能包含空格。

例如下面变量，有些是合法的，有些是不合法的：

> abc\_xyz：合法。  
> HelloWorld：合法。  
> abc：合法。  
> xyz\#abc：不合法，标识符中不允许出现“\#”号。  
> abc1：合法。  
> 1abc：不合法，标识符不允许数字开头。

##### 2. 命名规范 #####

*  模块、包、方法、函数、实例、参数和变量都用小写`下划线命名`。  
    如：
    
    > module\_name, 模块  
    > package\_name, 包  
    > method\_name, 方法  
    > function\_name, 函数  
    > instance\_var\_name, 实例  
    > function\_parameter\_name, 参数  
    > local\_var\_name. 本变量
 *  类、异常、常量都用大写帕斯卡命名规则。
    
    > ClassName, 类  
    > ExceptionName, 异常  
    > GLOBAL\_VAR\_NAME, 常量
 *  缩写  
    命名应当尽量使用全拼写的单词，缩写的情况有如下两种：  
    1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。  
    2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
    
    例如：
    
    > function 缩写为 fn  
    > text 缩写为 txt  
    > object 缩写为 obj  
    > count 缩写为 cnt  
    > number 缩写为 num，等。
 *  前导后缀下划线  
    一个前导下划线：表示非公有。  
    一个后缀下划线：避免关键字冲突。  
    两个前导下划线：当命名一个类属性引起名称冲突时使用。  
    两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如\_\_init\_\_或者\_\_file\_\_。绝对不要创造这样的名字，而只是使用它们。  
    *注意*：关于下划线的使用存在一些争议。
 *  特定命名方式  
    主要是指`__xxx__`形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如
    
        class Base(object):
        def __init__(self, id, parent = None):
        self.__id__ = id
        self.__parent__ = parent
        def __message__(self, msgid):
        # 其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。

##### 3. Python 的关键字和内置函数 #####

Python 非常方便，开发者可以通过 Python 程序来查看它所包含的关键字。例如，对于如下程序：

#导入keyword 模块
    import keyword
    #显示所有关键字
    keyword.kwlist

> \[‘False’,‘None’,‘True’,‘and’,‘as’,‘assert’,‘break’,‘class’,‘continue’,‘def’,‘del’,‘elif’,‘else’,‘except’,‘finally’,‘for’,‘from’,‘global’,‘if’,‘import’,‘in’,‘is’,‘lambda’,‘nonlocal’,‘not’,‘or’,‘pass’,‘raise’,‘return’,‘try’,‘while’,‘With’,‘yield’\]

上面这些是python内置的关键字，不能用来命名。

`！！！注意！！！`  
python的内置函数是可以用来命名的，但是采用函数名命名后，该函数不能使用，因为被覆盖了。  
比如：

a=[1,2,3]
    len=10
    print (len(a))

上面例子中的python内置的`len`函数被覆盖了，所以会报错。

Python内置函数

<table> 
 <thead> 
  <tr> 
   <th align="left">1</th> 
   <th align="left">2</th> 
   <th align="left">3</th> 
   <th align="left">4</th> 
   <th align="left">5</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">abs()</td> 
   <td align="left">all()</td> 
   <td align="left">any()</td> 
   <td align="left">basestring()</td> 
   <td align="left">bin()</td> 
  </tr> 
  <tr> 
   <td align="left">bool()</td> 
   <td align="left">bytearray()</td> 
   <td align="left">callable()</td> 
   <td align="left">chr()</td> 
   <td align="left">classmethod()</td> 
  </tr> 
  <tr> 
   <td align="left">cmp()</td> 
   <td align="left">compile()</td> 
   <td align="left">complex()</td> 
   <td align="left">delattr()</td> 
   <td align="left">dict()</td> 
  </tr> 
  <tr> 
   <td align="left">dir()</td> 
   <td align="left">divmod()</td> 
   <td align="left">enumerate()</td> 
   <td align="left">eval()</td> 
   <td align="left">execfile()</td> 
  </tr> 
  <tr> 
   <td align="left">file()</td> 
   <td align="left">filter()</td> 
   <td align="left">float()</td> 
   <td align="left">format()</td> 
   <td align="left">frozenset()</td> 
  </tr> 
  <tr> 
   <td align="left">getattr()</td> 
   <td align="left">globals()</td> 
   <td align="left">hasattr()</td> 
   <td align="left">hash()</td> 
   <td align="left">help()</td> 
  </tr> 
  <tr> 
   <td align="left">hex()</td> 
   <td align="left">id()</td> 
   <td align="left">input()</td> 
   <td align="left">int()</td> 
   <td align="left">isinstance()</td> 
  </tr> 
  <tr> 
   <td align="left">issubclass()</td> 
   <td align="left">iter()</td> 
   <td align="left">len()</td> 
   <td align="left">list()</td> 
   <td align="left">locals()</td> 
  </tr> 
  <tr> 
   <td align="left">long()</td> 
   <td align="left">map()</td> 
   <td align="left">max()</td> 
   <td align="left">memoryview()</td> 
   <td align="left">min()</td> 
  </tr> 
  <tr> 
   <td align="left">next()</td> 
   <td align="left">object()</td> 
   <td align="left">oct()</td> 
   <td align="left">open()</td> 
   <td align="left">ord()</td> 
  </tr> 
  <tr> 
   <td align="left">pow()</td> 
   <td align="left">print()</td> 
   <td align="left">property()</td> 
   <td align="left">range()</td> 
   <td align="left">raw_input()</td> 
  </tr> 
  <tr> 
   <td align="left">reduce()</td> 
   <td align="left">reload()</td> 
   <td align="left">repr()</td> 
   <td align="left">reversed()</td> 
   <td align="left">zip()</td> 
  </tr> 
  <tr> 
   <td align="left">round()</td> 
   <td align="left">set()</td> 
   <td align="left">setattr()</td> 
   <td align="left">slice()</td> 
   <td align="left">sorted()</td> 
  </tr> 
  <tr> 
   <td align="left">staticmethod()</td> 
   <td align="left">str()</td> 
   <td align="left">sum()</td> 
   <td align="left">super()</td> 
   <td align="left">tuple()</td> 
  </tr> 
  <tr> 
   <td align="left">type()</td> 
   <td align="left">unichr()</td> 
   <td align="left">unicode()</td> 
   <td align="left">vars()</td> 
   <td align="left">xrange()</td> 
  </tr> 
  <tr> 
   <td align="left">Zip()</td> 
   <td align="left"><strong>import</strong>()</td> 
   <td align="left">apply()</td> 
   <td align="left">buffer()</td> 
   <td align="left">coerce()</td> 
  </tr> 
  <tr> 
   <td align="left">intern</td> 
   <td align="left"></td> 
   <td align="left"></td> 
   <td align="left"></td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>