我是Visual Studio Code的新手,我开始使用它来开发PowerShell脚本。
我看到当我将光标放在某个函数的名称上时,会获得该函数的参数概述,但是当我使用自己的自定义函数执行此操作时,它不会执行该操作。
如何为PowerShell函数声明可通过Visual Studio代码显示在概述中的文档?
我试图这样做:
var fruit = fridge.food as! Fruit
fruit.color = "Red"
但这似乎不起作用。
非常感谢
在说明中添加.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"}
,
我以前的答案是错误的,尽管继续阅读Comment Based Help对于一般记录cmdlet还是个好主意。
为了使vscode
能够了解您的函数定义,需要在其内部Powershell主机中定义函数。如果您可以打开Powershell Integrated
终端,则可以进行点源处理(运行类似. myScript.ps1
的脚本以读取函数定义。运行任何代码以执行之前,您可能需要先make sure the script wasn't dot-sourced(基本上将您的运行时代码放在if块中,以检查脚本是否是点源的,但将函数定义保留在此条件之外)。
一旦脚本已在Powershell Integrated
终端中以点源方式提供,您将根据需要获得用法工具提示弹出窗口。要使其“自动”,请从$profile
终端解析vsvode
来点源脚本。
这不是特别理想,我希望找到一种更简化的解决方案,因为必须将我正在使用的每个脚本都点源化。