有没有办法以编程方式加载.ps1脚本文件的文档,而不是像get-help这样的命令?换句话说,除了过滤get-help本身的字符串输出之外,可以通过编程方式访问.SYNOPSIS,.DESCRIPTION等下定义的文本吗?
除此之外,我正试图在我的脚本库中找到文档覆盖范围方面的差距。我还希望能够显示某些脚本的列表及其概要。
答案 0 :(得分:4)
是的,这些都是可以访问的。 Get-Help
返回(就像任何其他cmdlet一样)一个对象,该对象的默认呈现是您在控制台中看到的。
但是,如果您通过get-help
输出format-list
的输出,请执行以下操作:
get-help get-childitem | format-list
您将获得属性的名称 - 值对列表。要获得概要,您可以执行以下操作:
get-help get-childitem |select-object -property synopsis
输出:
Synopsis
--------
Gets the files and folders in a file system drive.
如果您的.ps1
文件中没有定义cmdlet(基于注释的帮助涵盖整个脚本),则get-help file.ps1|select synopsis
应该有效。否则,你需要点源"要将cmdlet定义加载到内存中的文件,然后使用上面的get-help
。