基于注释的帮助示例中支持的标题,适用于基于脚本的函数
作者: MariusStorhaug创建于 2024年6月19日更新于 2026年9月16日
标签Issue-EnhancementWG-Interactive-HelpSystemWG-Reviewed
PowerShell 的基于注释的帮助系统支持用于脚本功能的 `.EXAMPLE` 指令,用于记录使用示例。当调用 `Get-Help -Examples` 时,每个示例都会以自动生成的标题(例如 `示例 1`、`示例 2` 等)显示。使用基于 MAML 的帮助的编译的 cmdlet 已经支持在示例上定制标题(例如 `示例 1: 获取项`)。然而,基于注释的帮助(用于脚本功能和模块的主要文档方法)没有相应的机制。
内容来源: PowerShell/PowerShell