是什么让 Perl 代码变得可维护？

Question

我已经编写 Perl 好几年了，它是我首选的文本处理语言（我研究的许多遗传学/基因组学问题很容易简化为文本处理问题）。 Perl 作为一种语言可以非常宽容，并且可以用 Perl 编写非常糟糕但实用的代码。就在前几天，我的朋友说他称 Perl 为一种只写语言：编写一次，理解一次，完成后永远不要尝试回去修复它。

虽然我有时确实因编写糟糕的脚本而感到内疚，但我觉得我也用 Perl 编写了一些非常清晰且可维护的代码。但是，如果有人问我什么使代码清晰且可维护，我将无法给出自信的答案。

是什么让 Perl 代码变得可维护？或者也许更好的问题是是什么让 Perl 代码难以维护？让我们假设我不是唯一维护代码的人，并且其他贡献者（像我一样）不是专业的 Perl 程序员，而是具有编程经验的科学家。

Answer 1

是什么导致 Perl 代码难以维护？几乎任何使其他程序无法维护的事情。假设除了旨在执行明确定义的任务的简短脚本之外的任何内容，这些是：

• 全局变量
• 缺乏关注点分离：整体脚本
• 不使用自文档标识符（变量名称和方法名称）。例如，您应该从变量的名称中知道其用途。 $c 不好。 $count 更好。 $token_count 很好。
  • 拼写标识符。程序大小不再是最重要的问题。
  • 名为 doWork 的子例程或方法不执行任何操作
  • 可以轻松地从另一个包中找到符号的来源。使用显式包前缀，或通过 use MyModule qw(list of import) 显式导入使用的每个符号。
• Perl 特定的：
  • 过度依赖快捷方式和模糊的内置变量
  • 滥用子例程原型
  • 不使用严格并且不使用警告
• 重新发明轮子而不是使用已建立的库
• 不使用一致的缩进风格
• 不使用水平和垂直空格来引导读者

等等。

基本上，如果您认为 Perl 是 -f>@+?*<.-&'_:$#/%!，并且您渴望在生产代码中编写类似的东西，然后，是的，你就会遇到问题。

人们往往会将 Perl 程序员为了好玩而做的事情（例如，JAPH、高尔夫等）与优秀的 Perl 程序应该是什么样子混为一谈。

我仍然不清楚他们如何能够在头脑中分离 代码 为IOCCC 来自可维护的 C.

Answer 2

我建议：

1. 不要对 Perl 太聪明。如果您开始使用代码打高尔夫球，则会导致代码更难阅读。您编写的代码需要可读且清晰，而不是聪明。
2. 记录代码。如果是模块，请添加描述典型用法和方法的 POD。如果是程序，请添加 POD 来描述命令行选项和典型用法。如果存在复杂的算法，请将其记录下来并提供参考（URL）（如果可能）。
3. 使用 /.../x 形式的正则表达式，并记录它们。并不是每个人都很好地理解正则表达式。
4. 了解什么是耦合，以及高/低耦合的优缺点。
5. 了解什么是内聚力，以及高/低内聚力的优缺点。
6. 适当地使用模块。一个定义良好、包含良好的概念可以构成一个很棒的模块。目标是重用此类模块。不要仅仅为了减小整体程序的大小而使用模块。
7. 为您的代码编写单元测试。一个好的测试套件不仅可以让您证明您的代码今天可以工作，而且明天也可以。它还可以让您在未来进行更大胆的更改，并确信您不会破坏旧的应用程序。如果你确实破坏了一些东西，那么，你的测试套件不够广泛。

但总的来说，您足够关心可维护性并提出相关问题，这一事实告诉我您已经处于一个好的位置并且以正确的方式思考。

Answer 3

我没有使用全部 Perl 最佳实践，但这就是 Damian写它是为了。无论我是否使用所有建议，它们至少都值得考虑。

Answer 4

什么使 Perl 代码易于维护？

至少：

use strict;
use warnings;

请参阅 perldoc perlstyle 了解一些通用指南，这些指南将使您的程序更易于阅读和理解，并维持。

Answer 5

对于代码可读性非常重要的一个因素是空白的重要性，这一点我在其他答案中没有提到过，它既与 Perl 无关，又在某些方面与 Perl 相关。

Perl 允许您编写非常简洁的代码，但简洁的代码块并不意味着它们必须全部聚集在一起。

当我们谈论可读性时，空白有很多含义/用途，并非所有这些都被广泛使用，但最有用：

• 标记周围的空格可以更轻松地在视觉上分隔它们。

  这个空间在 Perl 中尤为重要，因为即使在最佳风格的 Perl 代码中也普遍存在行噪声字符。

  我发现 $myHashRef->{$keys1[$i]}{$keys3{$k}} 在生产紧急情况下的凌晨 2 点与间隔时间相比可读性较差：
  $myHashRef->{ $keys1[$i] }->{ $keys3{$k} }。

  作为旁注，如果您发现您的代码执行大量以相同根开头的深层嵌套引用表达式，那么您绝对应该考虑将该根分配给临时指针（请参阅 Sinan 的评论/答案）。

  一个部分但非常重要的特殊情况当然是正则表达式。 因此我不会进一步延长这篇文章，除非有人在评论中请求示例。

• 缩进正确且均匀。噢。明显地。然而，我看到太多的代码由于蹩脚的缩进而 100% 不可读，而且当一半代码由一个使用 4 个字符制表符的编辑器使用制表符缩进的代码和另一个使用 8 个字符制表符的编辑器的人用制表符缩进时，可读性更差。只需将你该死的编辑器设置为软（例如空间模拟）TAB，不要让其他人痛苦。

• 逻辑上独立的代码单元周围的空行（块和行集）。你可以用 1000 行好的 Perl 编写一个 10000 行的 Java 程序。现在，如果您在这 1000 行中添加 100-200 行空行以使内容更具可读性，那么您就不会像 Benedict Arnold 那样了。

• 将超长表达式拆分为多行，紧接着...

• 正确的垂直对齐方式。见证之间的区别：

  if ($some_variable > 11 && ($some_other_bigexpression < $another_variable || $my_flag eq "Y") && $this_is_too_bloody_wide == 1 && $ace > my_func() && $another_answer == 42 && $pi == 3) {
  

  和

  if ($some_variable > 11 && ($some_other_bigexpression < $another_variable || 
      $my_flag eq "Y") && $this_is_too_bloody_wide == 1 && $王牌> my_func()
      && $another_answer == 42 && $pi == 3) {
  

  和

  if ( $some_variable > 11
      && ($some_other_bigexpression < $another_variable || $my_flag eq "Y")
      && $this_is_too_bloody_wide == 1
      && $王牌> my_func()
      && $another_answer == 42
      && $pi == 3) {
  

  就我个人而言，我更喜欢通过对齐 LHS 和 RHS 来进一步修复垂直对齐（这在长 SQL 查询的情况下尤其可读，而且在 Perl 代码本身中，无论是像这样的长条件语句还是多行语句）赋值和哈希/数组初始化）：

  if ( $some_variable > 11
      && ($some_other_bigexpression < $another_variable || $my_flag eq "Y")
      && $this_is_too_bloody_wide == 1
      && $王牌> my_func()
      && $another_answer == 42
      && $pi == 3 ) {
  

  顺便说一句，在某些情况下，通过首先不使用如此长的表达式，可以使代码更具可读性/可维护性。例如，如果 if(){} 块的内容是 return，则执行多个 if/unless 语句，每个语句都有一个 return块可能会更好。

Answer 6

我认为这是一个人们被告知 Perl 不可读的问题，他们开始对自己代码的可维护性做出假设。如果您足够认真地将可读性视为高质量代码的标志，那么这种批评很可能不适用于您。

大多数人在讨论可读性时都会引用正则表达式。正则表达式是嵌入在 perl 中的 dsl，您可以读取也可以不读取它们。如果有人不能花时间去理解对许多语言来说如此基本和重要的东西，我不关心试图弥合一些推断的认知差距......他们应该振作起来，阅读 perldocs，并在必要时提出问题。

其他人会引用 Perl 对短格式变量的使用，例如 @_、$!等等，这些都很容易消除歧义...我对让 perl 看起来像 java 不感兴趣。

所有这些怪癖和优点的好处是，用该语言编写的代码库通常简洁紧凑。我宁愿读十行 Perl，也不愿读一百行 Java。

对我来说，“可维护性”不仅仅是拥有易于阅读的代码。编写测试、做出断言...尽一切努力依靠 Perl 及其生态系统来保持代码正确。

简而言之：编写程序首先是正确的，然后是安全的，然后是性能良好的......一旦实现了这些目标，然后担心是否能舒服地蜷缩在火边。

Answer 7

我想说的是包装/对象模型，它反映在 .pm 文件的目录结构中。为了攻读博士学位，我编写了很多 Perl 代码，之后我又重复使用这些代码。它用于自动 LaTeX 图表生成器。

Answer 8

我将谈论一些积极的事情来使 Perl 易于维护。

确实，您通常不应该太聪明地使用像 return !$@;#% 之类的非常密集的语句，但要聪明地使用列表处理运算符，例如 map 和 grep 以及 list-context 从 split 之类的操作符返回，以便以函数式风格编写代码可以做出积极的贡献可维护性。在我的上一个雇主中，我们也有一些以类似方式工作的时髦哈希操作函数（hashmap 和 hashgrep，尽管从技术上讲，我们只向它们提供偶数大小的列表）。例如：

# Look for all the servers, and return them in a pipe-separated string
# (because we want this for some lame reason or another)
return join '|', 
       sort
       hashmap {$a =~ /^server_/ ? $b : +()} 
       %configuration_hash;

另请参阅高阶 Perl、http://hop.perl.plover.com - 如果您可以防止元编程本身妨碍的话，充分利用元编程可以使定义任务更加连贯和可读。