关键点:
a)工作流中不支持基于注释的帮助(标识工作流的帮助文件的 .ExternalHelp 注释除外)。
b)支持get-help参数的方式:使用 .ExternalHelp 注释以便 Get-Help 找到帮助主题,帮助主题建议的名称格式 <Script-module-base-name>.psm1-help.xml
c)支持在线帮助:使用CmdletBinding 属性的 HelpUri 属性提供在线帮助的地址
例b:
1.在脚本模块 (.psm1) 中包含脚本工作流 2.使用基于 XML 的 cmdlet 帮助主题格式为脚本工作流编写帮助主题 3.添加 .ExternalHelp 注释,它为工作流指定基于 XML 的 cmdlet 帮助主题的名称(.ExternalHelp 注释的详细信息请参阅 http://go.microsoft.com/fwlink/?LinkID=144309)
#.ExternalHelp <Script-module-base-name>.psm1-help.xml Workflow New-Package { ... } Workflow Set-Package { ... }
例c:
#.ExternalHelp <Script-module-base-name>.psm1-help.xml Workflow New-Package { [CmdletBinding(HelpURI="http://www.baidu.com")] Param ([Parameter]$ServerName) ... }
时间: 2024-10-26 23:23:20