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 创作此类帮助文件最简单。 模块，它允许以编译为 MAML 格式的 Markdown 格式 (*.md) 文件编写帮助。

您无法通过基于注释的帮助自定义示例命令部分标题(至少从 PowerShell 7.2.x 开始是这样，但我怀疑这一点不会改变) - 请参阅.EXAMPLE section about_Comment_Based_Help 概念帮助主题中的文档。

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