产品名称：PowerShell HelpWriter

生产厂商：SAPIEN产品类别：系统工具

第一个经过专业设计的环境，用于编写和编辑Windows PowerShell帮助文件。

功能亮点

• 生成模块的帮助文件。
• 创建和编辑主题。
• 实时拼写检查。
• 从头开始创建和设计模块帮助。
• 功能齐全的编辑器可帮助您编写准确而完整的帮助主题。
• 使用设计器或直接使用XML编辑器来编辑帮助文件。
• 支持所有命令类型：cmdlet，函数，工作流，CIM命令。
• 将基于注释的帮助转换为PSMAML文件。
• 为模块中的任何命令或所有命令生成启动程序帮助。
• 将帮助导出到Markdown或HTML。
• 刷新内容以反映模块中的更改。
• 使用文件恢复功能来防止工作丢失。

PowerShell HelpWriter是Windows PowerShell XML帮助文件的主要编辑器。为所有命令类型创建和编辑帮助文件，包括cmdlet，函数，工作流和CIM命令。关注您的内容，让PowerShell HelpWriter担心XML。

PowerShell HelpWriter将分析您的模块，并生成与cmdlet代码匹配的启动程序帮助文件，并转换现有的基于注释的帮助。

只需按一下按钮，即可将PowerShell帮助导出为HTML或markdown。

在将代码编写为代码规范之前，请为模块写帮助。编写帮助后，请使用PowerShell Studio的“帮助文件中的新建模块”功能自动生成模块的代码。

主要特点

完整的帮助编辑器用户界面

具有动态编辑器，可指导您完成为所有命令编写完整而准确的帮助主题的过程。

从模块生成帮助文件

无需从头开始。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文件

所有帮助文件均符合Windows PowerShell帮助文件的PSMAML架构。使用“验证帮助架构”功能来验证任何文件。PowerShell HelpWriter将自动更正常见的结构性问题，以符合MAML帮助架构。