最近在编写代码的时候,形成了一个好的习惯,那就是规范化命名。
我们经常在软件更新的时候看到有一个正式版和Beta版本。普通人对这两个版本之间并没有什么印象,有的是为了追求新奇,有的则是Geek心理。直到最近开始,正式编程的时候,才发现命名是有大学问。
为什么要用标准命名法
在科研过程中,往往重内容,不重视命名。但是,一旦代码的迭代次数变多了,就很容易弄乱,特别是在代码之间相互调用的时候,不同版本之间可能就会产生变量缺失、数据混乱等情况发生。更妨碍了在后续撰写使用说明时的便利程度。
有时为了图省事,会在代码名称后面加上时间。例如XXX_YYYYMMDD.py。这样做不仅不知道版本进化程度,反而当修改代码出现问题,需要回滚时,会出现找不到的情况。
我的标准命名方法
这个标准命名方法由以下几部分组成,合起来就是Packname_V_a_b_c_category.py组成。
其中,Packname精炼地描述了代码的功能用途,例如用于后端计算的代码则采用了Backend_calc这样的形式。Packname的名称不宜过长,尽量采用简写形式,既方便记忆,同时又节省空间。
V是Version,即版本的缩写。
a则是大改的版本,也就是说,框架层面上是基本不动的。
b则是中改,例如其中增加、修改、删减了class类,或者顺序的调整。
c则是小改,例如class中增加了变量,引用包的改写等。
至于category,我将其分为alpha, beta, RC和(Null)。其中,alpha是有很多bug,这个部分适用于未完成版本,可以尽可能的大改。beta则适用于可以正常运行,但是其中还是有一些不确定因素,需要增加。RC则是Release candidate版本,即大部分没有问题,仅需要看他人测试,用于候选的版本。而Null实际上就是什么也不加,也可以说称之为Stable版本。
命名配合
通常,各版本的命名配合是通过自己记录。通常在配合时,以a数字作为抓手。这样方便记忆。