Question

我想将脚本示例的相同样式的文档应用于我的脚本，这些脚本经常在本机文档中演示。例如，考虑Get-Help Invoke-Command -Examples命令的帮助。

Example 3: Run a command in a persistent connection

PS C:\>$s = New-PSSession -ComputerName Server02 -Credential Domain01\User01
PS C:\> Invoke-Command -Session $s -ScriptBlock {Get-Culture}

此命令的输出包含以下内容：

-------------------------- EXAMPLE 3 --------------------------

如何命名我的示例，使其显示为上面而不是默认的.EXAMPLE标题？在文档标记中使用PS C:\?指令时会渲染后者。

此外，如何利用多行示例使它们包含shell路径前缀（WebView）。我可以在我的文档中手动输入这个前缀来创建效果，但我想知道是否有一个不同的，更符合要求的方法。

Answer 1

执行此操作的方法是使用外部帮助MAML XML文件。手动创建，或使用PlatyPS模块从markdown创建MAML。您还可以使用PlatyPS从基于评论的帮助（CBH）创建降价。

使用PlatyPS：

# Create markdown from CBH in a module
New-MarkdownHelp -Module MyModule -OutputFolder .\docs -Locale en-US

# Create MAML external help, usually in a build step
New-ExternalHelp -Path .\docs -OutputPath .\moduleOutFolder\en-US

# Then you can optionally replace the CBH with a link to the external help
# file so you only need to adjust the markdown

<#
.EXTERNALHELP MyModuleName-help.xml
#>

创建初始降价时，您可能需要手动调整多行示例的降价。出于这个原因和一些其他偏好差异，我通常只保持降价并替换CBH。

如何在PowerShell脚本文档中格式化和命名示例？

1 个答案: