perl 代码规范

利用perl 写程序一定要注意代码的规范。不能够随心所欲。这里我记录下自己写perl程序的原则

头文件

每个含有源代码的文件必须在文件开始有关于该文件的介绍性注释。如列出文件名、创建者、创建日期、功能描述、版本信息、版权声明;如果对文件进行了修改,应该在文件头中说明。

## author: yudalang
## data: 2017.03.01

程序脚本的整体布局

-- 头文件
|
-- use module 或者 require perlScript or module
|
-- 程序的主体
|——open 文件读入
|——生成要处理的数据结构 或者 自己写测试程序
|——按照自己的目的组织写程序
|——output
|
-- 子程序

文件名

我用文件名来识别各个perlScripts,文件名中尽量包含多样的信息。
例如:calPcc.pl

文件句柄使用全大写形式,保存文件句柄的变量名及引用名使用前缀fh_。

变量

1.局部变量的开头必须用小写字母,为了识别变量的信息,组合第二个单词的时候前面一定要加一个下划线!!。
例如 : $line_oop

为什么是这种风格,请看这里

2.全局变量第一个字母要大写。每个全局变量必须要有详细的说明!

3.boolean 型的变量,在命名时要反映其属性,必须用is 或者 has 开头。

my $is_valid;
my $has_end_tag;

子程序

对子程序名的要求是子程序的名称要反映其功能:

可按如下的方式命名:

sub is_prime {
      ### do something
}

sub has_primes {
      ### do something
}

你可能感兴趣的:(perl 代码规范)