有没有办法为运行时模块或脚本块编写帮助文本

Question

场景的简短说明。

我正在使用New-Module CmdLet制作对象。像这样：

$object = New-Module -Name 'Logger' {
    New-Variable -Name level -Value 200 -Option Constant
    Function log($msg) { Write-Host "$($script:level): $msg" }
    Export-ModuleMember -Variable * -Function *
} -AsCustomObject
$object.log("New user")

我

正在使用该方法创建一个对象，因为它是唯一为我提供基于对象常量注释的函数帮助的方法（我所了解的）。但是，我想向整个脚本块或模块添加注释，以便在我执行Get-Help $object时获得帮助文本。我尝试在脚本块的开头放置一个基于注释的帮助文本：

$object = New-Module -Name 'Logger' {
<#
    Helpful info.
#>
    New-Variable -Name level -Value 200 -Option Constant
    Function log($msg) { Write-Host "$($script:level): $msg" }
    Export-ModuleMember -Variable * -Function *
} -AsCustomObject

它创建了对象，但通过 Get-Help 运行它只是给了我 Get-Help 的帮助文本。

有没有更好的方法来做到这一点或我缺少的东西。还是没有这样的能力？

Answer 1

除了创建about_{your-module-name}.txt文件之外，没有针对模块的顶级帮助。 尝试在PSWorkflow或PSScheduledJob或任何其他模块上获取帮助。 唯一要做的就是列出命令，除非模块有about_主题。当您为该模块执行"获取帮助 Pscx"时，您将获得about_pscx.txt主题。 该机制的工作原理是将about_主题文件放在关联的模块文件旁边。 不确定这将如何适用于您正在创建的动态模块。