V1.8
20011年7月
Perl编程规范
目录
一、基本要求...................................................................................................................................................... 3 二、可读性要求.................................................................................................................................................. 3 三、结构化要求.................................................................................................................................................. 4 四、正确性与容错性要求.................................................................................................................................. 5 五、可重用性要求.............................................................................................................................................. 6 六、规范程序名.................................................................................................................................................. 6 七、变量名的定义.............................................................................................................................................. 7 八、编写人员信息.............................................................................................................................................. 8 九、版本控制...................................................................................................................................................... 9 九、程序风格...................................................................................................................................................... 9
2
Perl编程规范
一、基本要求
1.1 程序结构清晰，简单易懂，
单个函数的程序行数不得超过100行。
1.2 打算干什么，要简单，直接了当，
代码精简，避免垃圾程序。
1.3 尽量使用标准库函数和公共函数。
1.4 不要随意定义全局变量，
尽量使用局部变量。
1.5 使用括号以避免二义性
二、可读性要求
2.1 可读性第一，效率第二。
2.2 保持注释与代码完全一致。
2.3 每个源程序文件，都有文件头说明，说明规格见规范和例程。
3
Perl编程规范
2.4 每个函数，都有函数头说明，说明规格见规范和例程。
2.5 主要变量（结构、联合、类或对象）定义或引用时，变量名能反映其含义。
2.6 常量定义（DEFINE）有相应说明。
2.7 处理过程的每个阶段都有相关注释说明。
2.8 在典型算法前都有注释。
2.9 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位， Tab为 4 个space。
2.10 循环、分支层次不要超过五层。
2.11 注释可以与语句在同一行，也可以在上行。
2.12 空行和空白字符也是一种特殊注释。
2.13 一目了然的语句不加注释。
2.14 注释的作用范围可以为：定义、 引用、条件分支以及一段代码。
2.15 注释行数应占总行数的 1/5 到 1/3 。（不包括程序头和函数头说明部份）三、结构化要求
定义4
Perl编程规范
3.1 禁止出现两条等价的支路。
3.2 禁止GOTO语句。
3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
3.4 用 CASE 实现多路分支。
3.5 避免从循环引出多个出口。
3.6 一个函数尽量保证只有一个return（简单函数除外）
3.7 不使用条件赋值语句。
3.8 避免不必要的分支。
3.9 不要轻易用条件分支去替换逻辑表达式。
四、正确性与容错性要求
4.1 程序首先是正确，其次是优美。
4.2 无法证明你的程序没有错误，因此在编 写完一段程序后，应先回头检查。
4.3 改一个错误时可能产生新的错误，因此 在修改前首先考虑对其它程序的影响。
5
Perl编程规范
4.4 所有变量在调用前必须被初始化。
4.5 对所有的用户输入，必须进行合法性检查。
4.6 不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ，不可靠
4.7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件 能否逻辑锁定、打印机是否联机等。
4.8 单元测试也是编程的一部份，提交联测试的程序必须通过单元测试。
4.9 为自己的程序准备测试集，每次修改后 运行测试集中所有测试用例。
五、可重用性要求
5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2 公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。
5.3 公共控件或类应建立使用模板。
六、规范程序名
6.1均使用英文
6.2单词之间用下划线连结
6
Perl编程规范
6.3专业词注意大小写，如：
BLAST EST cDNA
6.4程序相关的文件名要相互匹配，如：
scan_BLAST_results.sh
scan_BLAST_results.pl
scan_BLAST_results.pdf
scan_BLAST_results.log
scan_BLAST_results.out
scan_BLAST_results.xls
七、变量名的定义
7.1文件句柄（全部大写）：
FILEHANDLE_PHRAP_LIS
7.2静态变量（全部大写）：全局变量
7
Perl编程规范
$FIG_WIDTH_MAX
7.3普通变量（下划线连结的大小写）：
$node_user_id 或 $NodeUserID
7.4函数或子程序：
function_format_datetime()
sub_scan_foldlist_of_path()
八、编写人员信息
#!/usr/bin/perl -w
# programmer: Yechen (BGI)
# e-mail:yech@genomics.org.cn
# modified by xuzhao 2002-2-1
# 修改目的，功能说明
# 相应代码块开头要有对应说明
8
Perl编程规范
九、版本控制
$VERSION=0.90; #2001-07-30 by yechen
#...........
$VERSION=1.00; #2001-08-30 by yechen
#...........
$VERSION=1.05; #2001-09-30 by other
#...........
Usage 函数中输出版本号
九、程序风格
修改已有程序时请保持程序原来风格（风格一致性）
9
因篇幅问题不能全部显示，请点此查看更多更全内容