Perl编程格式指南

下载后可任意编辑Perl 编程格式指南名称P5EEx::Blue::perlstyle - P5EE 样式指导 P5EE 是 Perl 5 Enterprise Environment (企业型 Perl5 样式指导）的缩写。 介绍在 P5EE 发行版中,包含的所有代码和文件都遵循了本文所述的样式。请注意：这些样式并不是要抑制你的制造力，而是想要使那些阅读到你代码的家伙们的生活变得更容易一些。他也可以用来解决分歧，避开个人间纠纷。 下面的这些约定适用于 perl 模块，web 程序（CGI/mod_perl）以及命令行程序。当然，这些规则也在一定程度上适用于用 P5EE 写的 perl 代码。 注意，这些都是指导性的方针，不是必须遵守的规则。假如在这里你真的需要违反其中一条的话，无论如何，最好先问问 P5EE 核心团队。 另外，本文档中的大部分，并不是强调正确的方法就是我们的方法。我们需要有一些约定来让每个人的生活更容易一些。 假如你有什么问题，可以在 P5EE 开发邮件列表中询问，p5ee@perl.org. http://lists.perl.org/showlist.cgi?name=p5ee P5EE 项目所需文件在下面这些网站上可以找到。 http://p5ee.perl.org/ http://www.officevision.com/pub/p5ee 本文档将随时间不断更新，每份最新的文档结尾，都会有历次版本的变动记录。 编码规则Perl 版本我们是在 perl5.005_03 上编写所有代码的。也许有一天我们应该利用以下perl5.6 的特性。不管怎样，所有代码应该在 perl5.005_03 以及后续版本上都能运行。P5EE 所有的核心代码都在 perl5.005_03 和 perl5.6.0 上测试过，虽然现在 P5EE 用在 perl5.6 上比较多。 文档下载后可任意编辑所有的模块文档都应参照模块模板文件中的 POD 例子来撰写，解释模块的方法，目的，用途和每个带有名字，描述，输入，输出，受影响因素等信息的公用 API。 文档中，假如需要返回一个数组或哈希表的引用，要记录数组的大小（包括恰当地描述每个元素都是什么）和哈希表中每个键的名字。假如是复合数据结构的话，尽量描绘出合适的结构。 另外，在文档中还要记录出返回数据是什么类型的数值。是整型，还是一段 HTML 代码，还是一个布尔值？ 所有命令行程序的选项都要使用命令行程序样本文件中的代码来记录。每个有效的方法，switch 结构等等都要被记录，连同方法的描述，目的，程序如何使用。不要尝试对不同目的的程序使用相同的选项。 对于所有的 WEB 程序，应当在程序注释段中说明功能，目的和使用。 任何外部文...