Perl 最佳实践(节选) --- 03

第三章：命名惯例

零贰叁.

构成标示符时要使用文法模板。

l变量以名词命名，前面不加或再加上多个形容词：

variable → [adjective _ ]* noun

lhash和数组：

look-variable → [adjective _ ]* noun preposition

零贰肆.

根据相关测试替布尔值命名。

零贰伍.

把存储引用的变量标上_ref后缀。

零贰陆.

数组以复数命名，而散列以单数命名。

Perl有可用的格式化工具：perltidy。

网址：http://perltidy.sourceforge.net

零贰柒.

以下划线把多词标识符中的单词分隔开来。

零贰捌.

以大小写区分不同程序组件。

l子程序、方法、变量、加标签的自变量的名称都使用小写。

l包和类名使用混合的大小写。

l常量则使用大写。

零贰玖.

以前缀作为缩写。

注意：当你以前缀作为标识符的缩写时，保留最后的辅音字母是可以接受的（通常也是不可少的），特别是辅音字母是复数后缀时。

零叁零.

只在意义明确时才缩写。

零叁壹.

名称中避免使用模糊的词。

我们拒绝使用“last”。例如，名为$last_record的变量可能是指最近处理过的记录（此时应该称为$prev_record），但是也可能指列表中最终的记录（此时应该称为$final_record）。

其他应避免使用的常见词如下：

l“left”（方向 vs. 剩余之物）

l“right”（另一方向vs. 正确vs. 权利）

l“no”（否定vs. 数字的缩写）

l“contract”（缩小vs. 合约）

l“record”（最佳成绩vs.数据集vs. 记录）

l“second”（第二vs. 时间单位）

l“bases”（几座基地vs. 几项基础）

零叁贰.

“只供内部使用的”子程序要在开始处加上下划线。

我们拒绝使用“last”。例如，名为$last_record的变量可能是指最近处理过的记录（此时应该称为$prev_record），但是也可能指列表中最终的记录（此时应该称为$final_record）。

其他应避免使用的常见词如下：

l“left”（方向 vs. 剩余之物）

l“right”（另一方向vs. 正确vs. 权利）

l“no”（否定vs. 数字的缩写）

l“contract”（缩小vs. 合约）

l“record”（最佳成绩vs.数据集vs. 记录）

l“second”（第二vs. 时间单位）

l“bases”（几座基地vs. 几项基础）