powershell - 我可以使用基于注释的文档为示例添加标题吗？

Question

例如，Get-ChildItem有这个帮助:

-- Example 9: Output for experimental feature PSUnixFileStat --

    PS> Get-ChildItem /etc/r*

当我运行 Get-Help在我的东西上，酒吧只是说 Example <number> .

编写以下内容:

<#
.EXAMPLE Example title
example
#>

休息 Get-Help .

我需要使用 XML 帮助还是有其他东西？

PS:问题提交表格要求我不要在标题中使用“帮助”。在这种情况下，这有点愚蠢。

Answer 1

Do I need to use XML help or is there something else?

是的， 如果要自定义示例命令部分标题 ，则确实需要使用 MAML 格式的基于 XML 的帮助.通过 PlatyPS 编写此类帮助文件是最简单的。模块，它允许以 Markdown 格式 ( *.md ) 文件编写您的帮助，这些文件被编译为 MAML 格式。

至少从 PowerShell Core 7.0 开始， 您无法通过基于注释的帮助自定义示例命令部分标题 - 见 .EXAMPLE section about_Comment_Based_Help 中的文档概念性帮助主题。

该主题表明只有少数部分接受参数，并且 - 正如您所观察到的 - 尝试使用不支持的参数会完全破坏基于注释的帮助。