将哈希引用传递给子例程的命名约定

Question

当我将哈希引用传递给子例程时，分配哈希引用参数的变量的良好命名约定是什么？

在下面的示例中，更好的选择是什么：

1. 使用与原始变量相同的变量名（并让 Perl 将原始变量隐藏在块中）。
2. 为子例程中的哈希引用想出一个新名称？

我倾向于使用选项 1，因为相同哈希引用的新名称感觉多余。

如果选项 2 更好，那么子例程中的变量的良好命名约定是什么？

## example:

use strict;
use warnings;

my $href_phone_book = generate_phone_book();
my $phone_number = get_phone_number($href_phone_book, "john");

print $phone_number."\n";

sub generate_phone_book {

    my %phone_book = (

        john => "5554321",
        alice => "5551234"
    );

    return \%phone_book;
}

sub get_phone_number{

    # Is it OK to hide the original variable
    my $href_phone_book = shift;
    # Or should I use a new variable name? What would then be a good naming convention?

    my $person = shift;
    my $phone_number = $href_phone_book->{$person};

    return $phone_number;
}

Answer 1

您应该为变量引用的数据命名。理想情况下，您应该使用一个简短的、明确的名称，并在可能的情况下删除上下文。例如，如果您的函数所做的事情通常适用于任何哈希引用，则名称 $hash_ref 在 IMO 中比 $phone_book 更可取

1.使用与原始变量相同的变量名（并让 Perl 将原始变量隐藏在块中）。

虽然不是一个一般安全的假设，但它是我会在你的例子中做的。我会使用 $phone_book 作为单个参数。

请注意，如果您重复使用相同的引用数据结构作为函数的参数，那么它指向编写一些 OO Perl。您可能应该创建一个类，将对象的数据结构和函数更改为实例方法。

警告：由于范围可变，您的示例脚本将生成警告。所以我的建议需要修改。我不会更改子例程的变量，而是将全局变量命名为 $main_phone_book 之类的名称。 . .但这只是由于您的示例脚本的结构所必需的。理想情况下，您应该避免使用全局数据结构，并使用模块化（PhoneBook.pm 文件包含处理电话号码的所有逻辑，无论是导出函数还是新类，都不会因为包命名空间而在变量名上发生冲突）。或者，如果变量对于手头的问题确实是全局的，那么您可能根本不会将它们作为参数传递。

2。为子例程中的哈希引用想出一个新名称？

在这种情况下，仅由于示例脚本的文件结构而需要它。至少在单个脚本和模块级别的一致性比找到一些可以满足您所有需求的特殊命名约定更重要。

---

我建议你阅读Perl Best Practices 的变量命名约定章节。这是非常明确和有用的建议。