perl编码规范..docVIP

PERL编码规范 目 录 目录 目 录 III 1 文档介绍 5 1.1 文档目的 5 1.2 读者对象 5 1.3 文档说明 5 2 命名规则 6 2.1 文件命名 6 2.2 标识符 6 2.2.1 变量 6 2.2.2 包和类 6 2.2.3 标识符缩写 6 2.2.4 函数 7 2.3 布尔类型 7 2.4 数组和哈希 8 3 注释 9 3.1 文件头部注释 9 3.2 文件中注释 10 3.3 函数注释 10 3.4 程序块注释 10 3.5 语句注释 11 4 代码布局 12 4.1 括号 12 4.1.1 方式一 12 4.1.2 方式二 12 4.2 关键字 13 4.3 子程序和变量 14 4.4 代码缩排 14 4.5 代码块 14 4.6 代码长度 15 4.7 操作符 15 4.8 语句结束符 16 4.9 代码排列 16 4.10 非末端表达式 17 4.11 功能块顺序 17 5 数值和表达式 18 5.1 字符串界定符 18 5.2 常量 18 5.3 字符串 18 5.3.1 两行 18 5.3.2 多于两行 19 5.4 哈希变量 19 6 函数 20 6.1 调用语法 20 6.2 函数返回 20 7 编程惯例 21 7.1 使用use strict 21 7.2 避免使用内部变量名称 21 7.3 避免使用goto 21 7.4 语法检查（辅助工具） 22 7.5 使用标准模块 22 7.6 其他 22 文档介绍 文档目的 本文档目的是制定一种好的PERL编码规范，使PERL软件开发人员，按照统一的编码风格编写程序，减少软件项目的成本，提高软件产品的健壮性，提高程序的运行效率，提高软件产品的可读性和易维护性。 读者对象 PERL语言开发人员。 文档说明 文档中红色标注的部分为规范的编码。 文档中蓝色标注的部分为不规范的编码。 作者：perlchina 明 qq：492003149 命名规则 文件命名 文件名称统一用英文字母（大小写）、数字和下划线的组合，长度一般不超过20个字符，文件命名体现功能的含义，正式发布版本不能加入作者信息。Perl Scripts 文件的扩展名必须是.pl，Perl Module文件的扩展名必须是.pm。 正确： lucent_file_parser.pl 不是： lucent_file.p 标识符 采用语法模板来定义标识符的名字，命名必须有一定的实际意义，由英文字母组成，中间可以根据语义的连续性，使用下划线连接。 变量 局部变量必须由小写字母和下划线组成，常量名必须由大写字母和下划线组成。由多个单词组成的名字里，使用下划线_把多个单词分开。全局变量以’g_’开头，其余部分的命名规则和局部变量相同。每个全局变量必须有注释说明其作用。 正确： my $next_node; 不是： my $node; 包和类 包、类的命名采用大小写混合、首字母大写的方法。 正确： IO::Controller 标识符缩写 标识符缩写时要保留单词的开始字母，不是辅音字母的简写。 正确： use List::Util qw( max ); DESC: for my $desc (@orig_strs) { my $len = length($desc); next DESC if ($len $UPPER_LIM); $max_len = max($max_len, $len); } 不是： use List::Util qw( max ); DSCN: for my $dscn (@rgnl_strgs) { my $lngh = length $dscn; next DSCN if $lngh $UPPR_LMT; $mx_lngh = max($mx_lngh, $lngh); } 函数 由小写字母、下划线组成。 正确： sub max { …… } sub get_msc_name { …… } 不是： sub getMscName { …… } 布尔类型 boolean类型的变量，或返回boolean类型的值的函数，在命名时要反映其属性，必须用is或者has开头。 正确： sub is_valid; sub is_metadata_available_for; sub has_end_tag; my $has_loading_finished; my $has_found_bad_record;