powershell - 使用 Visual Studio Code 查看我的函数的文档字符串

Question

我是 Visual Studio Code 新手，我开始使用它来开发 PowerShell 脚本。

我发现，当我将光标放在函数名称上时，我可以获得该函数参数的概述，但是当我使用自己的自定义函数执行此操作时，它不会执行此操作。

如何声明可以通过 Visual Studio Code 在概述中显示的 PowerShell 函数的文档？

我尝试这样做:

<#
.Description
Get-Function displays the name and syntax of all functions in the session.
#>
function test([string]$print){}


<# Setup the working directories if they do not exist #>
If(!(Test-Path $WORKING_DIRECTORY)) {test}

但这似乎不起作用。

非常感谢

Answer 1

将 .PARAMETER 添加到描述中对我有用。另请注意，我相信您必须保存并运行脚本一次才能显示它。

<#
.Description
Get-Function displays the name and syntax of all functions in the session.
.PARAMETER  
#>

function test([string]$print){Write-Host $print}

If(Test-Path $env:userprofile) {test -print "Test123"}

https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-6