PoshCode/PowerShellPracticeAndStyle

## PowerShell 最佳实践与风格指南 [目录](#table-of-contents)

本作品采用 [知识共享署名-相同方式共享 4.0 国际许可协议](http://creativecommons.org/licenses/by-sa/4.0/) 进行许可，请注明原作者为 Don Jones, Matt Penny, Carlos Perez, Joel Bennett 以及 PowerShell 社区。 ###### 您可以自由地： **分享** — 在任何媒介或格式中复制和重新分发素材 **改编** — 混合、转换和基于素材进行构建 作者鼓励您尽可能广泛地重新分发此内容，但要求您注明下列主要作者，并在 GitHub 上通知我们所做的任何改进。 ### 什么是最佳实践 _PowerShell 最佳实践_ 是您作为起点通常应该做的事情。它们是编写、思考和设计的方式，可以让您更难陷入困境。_最佳实践_ 的重点是帮助读者掉进成功的坑里（fall into the pit of success）： 就像英语拼写和语法规则一样，PowerShell 编程最佳实践和风格规则几乎总是有例外，但我们正在记录代码结构、命令设计、编程、格式甚至风格的基线，这将帮助您避免常见问题，并帮助您编写更可重用、可读的代码——因为可重用的代码不需要重写，可读的代码可以维护。 话虽如此，请记住：最佳实践文档和风格指南中的要点被称为_实践_和_指南_，而不是规则。如果您因为试图避免_违反_风格或最佳实践规则而无法完成某事，那么您就误解了重点：本文档是务实的，而不是教条的。我们会将教条主义留给那些要求您遵守其特定准则的团队和项目。 ### 目录 指南分为以下几个部分： * [风格指南（介绍）](Style-Guide/Introduction.md) * [代码布局与格式化](Style-Guide/Code-Layout-and-Formatting.md) * [函数结构](Style-Guide/Function-Structure.md) * [文档与注释](Style-Guide/Documentation-and-Comments.md) * [可读性](Style-Guide/Readability.md) * [命名约定](Style-Guide/Naming-Conventions.md) * [最佳实践（介绍）](Best-Practices/Introduction.md) * [命名约定](Best-Practices/Naming-Conventions.md) * [构建可重用工具](Best-Practices/Building-Reusable-Tools.md) * [输出与格式化](Best-Practices/Output-and-Formatting.md) * [错误处理](Best-Practices/Error-Handling.md) * [性能](Best-Practices/Performance.md) * [安全](Best-Practices/Security.md) * [语言、互操作与 .NET](Best-Practices/Language-Interop-and-.NET.md) * [元数据、版本控制与打包](Best-Practices/Metadata-Versioning-and-Packaging.md) ### 当前状态： 请记住[我们对_最佳实践_的定义](#what-are-best-practices)。 *PowerShell 最佳实践* 总是在不断发展，并随着语言和工具（以及我们对它们的社区理解）的发展继续进行编辑和更新。我们建议您每年至少访问两次 [https://github.com/PoshCode/PowerShellPracticeAndStyle](https://github.com/PoshCode/PowerShellPracticeAndStyle) 查看新版本。 特别是 *PowerShell 风格指南* 目前处于预览状态，我们仍在通过 GitHub issues 系统积极解决关于指南中规则的分歧。

标签：AI合规, IPv6, IT管理, PowerShell, Windows运维, 代码可读性, 代码规范, 多人体追踪, 开源书籍, 技术文档, 数据管道, 最佳实践, 编程习惯, 网络调试, 脚本开发, 自动化, 软件工程, 风格指南