自定义注释中的原始数据,通过管道传递到格式表时具有Power-shell中的功能

时间:2018-10-22 18:13:53

标签: powershell powershell-v4.0

我正在尝试为我正在编写的电源外壳模块创建备忘单。我正在使用可以添加到Powershell模块中的函数中的自定义帮助消息。然后在每个方法上调用Get-Help,然后选择一些特定的输出并格式化为表格。我在尝试获取可以与Get-Help功能绑定的原始数据时遇到了麻烦。

示例电源壳模块

# example_psmod_psm1

#this is a test
function commitWithMessage() {
<#
.SYNOPSIS
git commit --verbose --message
.DESCRIPTION 
gitcm
.NOTES
Commits to local git repo with verbose and message flag 
#>  
   git commit --verbose --message $args[0]
}

“获得帮助”呼叫工作正常,当我进行以下呼叫时,它将在单个页面上显示正确的信息。

Get-Help commitWithMessage

get-help

但是当我尝试选择特定的字段,然后使用以下命令以表格形式输出时,我会这样做。

Get-Help commitWithMessage | Format-Table "DESCRIPTION", "SYNOPSIS","NOTES"

我得到以下信息。

enter image description here

我正在尝试弄清描述的内容以及如何获取文本数据。看来笔记没有从文件中拉出

1 个答案:

答案 0 :(得分:1)

format cmdlet将输出包装在更复杂的对象中(Microsoft.PowerShell.Commands.Internal.Format ...) 您可以使用

检查它们
Get-Help commitWithMessage | Format-Table "DESCRIPTION", "SYNOPSIS","NOTES" | get-member

我猜您正在搜索:

get-help commitWithMessage | select-object -ExpandProperty Description