PowerShell HelpWriter是一款由SAPIEN Technologies开发的工具，旨在帮助开发者为其PowerShell命令和模块快速生成帮助文档。这款工具能自动从代码中提取必要的信息，生成初步的帮助主题，既不需要开发者深入理解cmdlet属性或参数属性，也无需手动编写输入输出等详情。借此，开发者可以确保其编写的帮助文件总能与代码保持同步，无需担心文档过时。
PowerShell HelpWriter特别适合于需要创建和更新PowerShell XML帮助文件的场景。它为了CIM命令、cmdlets和函数等提供了直观的编辑器，能够支持开发者以结构化的方式编写和维护文档。更为方便的是，这款工具还集成了视频教程，有助于开发者学习如何为单个函数或整个模块创建新的帮助文件。
随着PowerShell应用的广泛性，PowerShell HelpWriter成为了脚本编写者的得力助手。它不仅提高了编写帮助文档的效率，而且通过自动生成的帮助主题，使得每个命令的功能和用途都能被清晰地展示给用户。无论是专业开发者还是PowerShell的初学者，PowerShell HelpWriter都能够帮助他们提供专业级别的用户文档，从而提升用户体验。
- 生成模块的帮助文件。
- 创建和编辑有关主题。
- 实时拼写检查。
- 从头开始创建和设计模块有帮助。
- 功能齐全的编辑器可帮助您编写准确且完整的帮助主题。
- 使用设计器或直接使用XML 编辑器编辑帮助文件。
- 支持所有命令类型：cmdlet、函数、工作流、CIM 命令。
- 将基于注释的帮助转换为 PSMAML 文件。
- 为模块中的任何命令或所有命令生成入门帮助。
- 将帮助导出为Markdown或HTML。
- 刷新内容以反映模块中的更改。
- 使用文件恢复功能防止工作丢失。
- 支持 Windows PowerShell 5.1 和 PowerShell 7
主要特征
完整的帮助编辑器 UI
具有动态编辑器，可指导您完成为所有命令编写完整且准确的帮助主题的过程。
从模块生成帮助文件
无需从头开始。PowerShell HelpWriter 分析您的模块并生成与 cmdlet 代码匹配的入门帮助文件。
管理模块帮助文件
使用模块项目来管理和编辑多个help-xml 和有关帮助文件。只需按一下按钮即可刷新模块的帮助内容。
实时拼写检查
PowerShell HelpWriter 在您编写时提供实时拼写检查。
帮助匹配代码
PowerShell HelpWriter 从任何类型的任何命令（包括单个命令和模块中的命令）中的代码生成入门帮助主题。无需弄清楚 cmdlet 属性或参数属性值、输入或输出。而且，帮助始终与代码匹配。
在 XML 中编辑
无论何时需要，您都可以在内置 XML 编辑器中查看或编辑帮助文件。PowerShell HelpWriter XML 编辑器是一个完整的 XML 编辑器，而不仅仅是一个只读查看器。
编辑现有帮助文件
在 PowerShell Help Writer 编辑器 UI 中编辑现有帮助文件或以 XML 形式编辑。添加或删除参数，包括动态参数。
从头开始创建帮助文件
使用 PowerShell HelpWriter 编辑器从头开始为新模块或现有模块创建帮助。
将基于注释的帮助转换为 PSMAML
从新 PSMAML 文件中的现有帮助生成入门帮助，包括基于注释的函数帮助。
Markdown 和 HTML 导出
将 cmdlet 帮助和有关主题导出为 Markdown 或 HTML。
编码前设计
在将代码编写为代码规范之前，为模块编写帮助。编写帮助后，使用 PowerShell Studio 的“从帮助文件中新建模块”功能自动生成模块的代码。
验证 PSMAML 文件
所有帮助文件都符合 PowerShell 帮助文件的 PSMAML 架构。使用验证帮助架构功能来验证任何文件。PowerShell HelpWriter 将自动更正常见的结构问题，以符合 MAML 帮助架构。
评论(0)