5 个 PowerShell 脚本最佳实践

您花了多少时间来破译同事或前任的代码？通常，混乱的代码背后并不存在复杂的科学原理，而是乍一看看起来很复杂的简单函数。

代码高尔夫在 Reddit 上可能很有趣，并且可以节省控制台时间，但它在专业脚本中没有地位。相反，你应该遵循简单的概念——这里的座右铭是：“不要让我思考！ ”。

用几行简洁的代码替换一行让水平滚动条费力的代码将为您的同事节省很多挫败感。在本文中，我将向您展示编写专业 PowerShell 代码的 5 个最佳实践，为您带来清晰、稳定和兼容性。

1. 干净的格式

PowerShell 解释器不关心漂亮的格式——所有代码都被严格地一个接一个地处理。您可以将整个代码写在一行中，只要您用“;”分隔单个语句即可。 ”。但这绝对不利于可读性，并且最晚当您想稍后再次处理代码时，您会后悔这个决定。

特别是在 PowerShell 职业生涯的初期，用户的格式往往不一致。以下是未格式化代码（图 1）和格式化代码（图 2）之间的直接比较：

图 1：未格式化的 PowerShell 代码

图 2：采用大括号样式格式化的 PowerShell 代码

正如您在图 2 中看到的，缩进为文本提供了更多的结构，并且可以在视觉上区分脚本块。运算符（+、= 等）之间的空格也可以提供清晰度。

对于如何引入脚本块，意见分歧很大。我是“一个真正的大括号样式”的粉丝：左大括号位于介绍性语句的末尾，右大括号位于介绍性语句的第一个字符下方的单独行上。 VSCode 或各种代码美化器可以通过自动格式功能简化您的工作。

2. 评论的使用

说实话，半年后你想更新自己的代码时，你也必须仔细考虑一下。代码注释使您和您的同事有机会将各个函数的解释作为代码中的注释留下。

单行评论用主题标签/散列打开。多行注释用打开，用用#>关闭（参见图3）。许多编辑器还提供通过热键注释所选行的功能（VSCode：Ctrl + Shift + 7）：

图 3：跨多行的 PowerShell 注释

但要注意：这里存在“过度注释”的危险——并非代码中的所有内容都需要注释。想想哪些代码行乍一看难以理解，然后重点关注那些代码行。

除了上面提到的功能之外，注释还可以用于为函数分配元信息。此时的关键词是“参数块”“概要”和“注释”。这些在 ScriptRunner ActionPack 中以示例性方式进行维护。

通过此元信息，可以通过Get-Help检索帮助。当然，文本可以自由选择并适应模块或功能内容。该信息将在相应的功能中维护。向文件添加文件扩展名的函数示例如图 4 所示：

图 4：评论中包含详细元信息的 PowerShell 函数

通过 Get-Help，PowerShell 管理员可以查询更多元信息（图 5）：

图 5：Get-Help cmdlet 的输出

3. 使用全面的变量名称和约定

我承认自己有罪 - 我也使用 $a, $b ，有时甚至$c。但仅限于第一步开发。

变量名称应该有意义，并且最迟在发布时显示其内容。列表应以复数形式命名，单个元素应以单数形式命名 - $user 与 $users 不同。

PowerShell 不区分大小写 - 但这并不意味着您应该混合所有可能的变体。您选择哪种惯例取决于您——只要您坚持下去！

以下约定适用于所有语言：

$snake_case
$PascalCase
$camelCase
$sHungarianNotation  # 's' at beginning means 'String'

4. 无需硬编码！

脚本中的硬编码是最严重的反模式之一！它不仅使您的代码变得动态和僵化，而且还可能成为危险的安全风险！

图 6：服务器名称和凭据作为参数传递的代码片段

我认识许多管理员，他们将用户名甚至密码或密钥以纯文本形式放入脚本中。许多人缺乏这方面的专业知识。在这种情况下，神奇的词是参数绑定。因此，信息可以从外部传递给脚本：

您可以在“PowerShell 高级函数”和“PowerShell 中的参数绑定概念”文章中阅读有关 CmdletBinding 的更多信息。

当调用脚本时，参数用于传递所需的信息。例如，ScriptRunner 软件平台可以访问安全密码保险箱并将密码传递给脚本，而不会产生任何安全风险 - 该功能称为“密码服务器连接器”。

5. 参数泼溅

在许多情况下，cmdlet 后面需要许多参数。这不仅看起来很混乱，而且通常会导致很长的代码行，从而导致水平滚动的尴尬。

哈希表可以帮助极大地简化您的代码。我所指的技术称为 PowerShell splatting。其目标是将参数分组到哈希表中。

例如，如果我们想通过邮件通知服务所有者其服务器重新启动（参见图 7），我们需要很多参数（第一行末尾的“back-tic”允许我扩展屏幕截图的代码为两行）：

图 7：没有 PowerShell 展开的命令，其中参数和值单独列出。

使用哈希表可以更好地显示相同的功能，如图 8 所示（为了清楚起见，此处已对值进行了硬编码）。

图 8：使用 PowerShell 展开的相同命令。参数和值位于哈希表中，该哈希表依次传递给命令。

此方法适用于所有 cmdlet 参数，并且由于获得的概述而使您的代码更易于维护。

结论

这些最佳实践为清晰的代码提供了良好的基础。特别是初学者和中级用户应该直接在代码中实现这些实践，因为具有上述优点，而不是仅限于纯功能。

此外，在许多 IT 环境中，都存在代码标准 - 因此在发布脚本之前会检查其约定和质量标准。