共用方式為


Test-ScriptFileInfo

驗證腳本的批註區塊。

語法

PathParameterSet (預設值)

Test-ScriptFileInfo
    [-Path] <String>
    [<CommonParameters>]

LiteralPathParameterSet

Test-ScriptFileInfo
    -LiteralPath <String>
    [<CommonParameters>]

Description

Cmdlet Test-ScriptFileInfo 會在腳本開頭驗證批注區塊,該腳本將會與 Publish-Script Cmdlet 一起發行。 如果批注區塊發生錯誤,此 Cmdlet 會傳回錯誤所在位置的相關信息,或如何修正錯誤。

範例

範例 1:測試腳本檔案

Test-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1"

此命令會測試 New-ScriptFile.ps1 腳本檔案,並顯示結果。 腳本檔案包含有效的元數據。

範例 2:測試具有所有元數據屬性值的腳本檔案

Test-ScriptFileInfo -Path "D:\code\Test-Runbook.ps1" | Format-List *
Name                       : Test-Runbook
Path                       : D:\code\Test-Runbook.ps1
ScriptBase                 : D:\code
ReleaseNotes               : {contoso script now supports following features, Feature 1, Feature 2, Feature 3...}
Version                    : 1.0
Guid                       : eb246b19-17da-4392-8c89-7c280f69ad0e
Author                     : pattif
CompanyName                : Microsoft Corporation
Copyright                  : 2015 Microsoft Corporation. All rights reserved.
Tags                       : {Tag1, Tag2, Tag3}
LicenseUri                 : https://contoso.com/License
ProjectUri                 : https://contoso.com/
IconUri                    : https://contoso.com/MyScriptIcon
ExternalModuleDependencies : ExternalModule1
RequiredScripts            : {Start-WFContosoServer, Stop-ContosoServerScript}
ExternalScriptDependencies : Stop-ContosoServerScript
Description                : Contoso Script example
RequiredModules            : {RequiredModule1, @{ ModuleName = 'RequiredModule2'; ModuleVersion = '1.0' }, @{ ModuleName = 'RequiredModule3'; RequiredVersion = '2.0' }, ExternalModule1}
ExportedCommands           : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-Workflow...}
ExportedFunctions          : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-AdvPSCmdlet}
ExportedWorkflows          : My-Workflow

此命令會測試腳本檔案 Test-Runbook.ps1,並使用管線運算符將結果傳遞至 Format-List Cmdlet 來格式化結果。

範例 3:測試沒有元數據的腳本檔案

Test-ScriptFileInfo -Path "D:\code\Hello-World.ps1"
Test-ScriptFileInfo : Script 'D:\code\Hello-World.ps1' is missing required metadata properties. Verify that the script file has Version, Description
and Author properties. You can use the Update-ScriptFileInfo or New-ScriptFileInfo cmdlet to add or update the PSScriptInfo to the script file.
At line:1 char:1
+ Test-ScriptFileInfo D:\code\Hello-World.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : InvalidArgument: (D:\code\Hello-World.ps1:String) [Test-ScriptFileInfo], ArgumentException

+ FullyQualifiedErrorId : MissingRequiredPSScriptInfoProperties,Test-ScriptFile

此命令會測試腳本檔案 Hello-World.ps1,該檔案沒有與其相關聯的元數據。

參數

-LiteralPath

指定通往一個或多個位置的路徑。 不同於 Path 參數, LiteralPath 參數的值會與輸入時完全相同。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元,請以單引弧括住它們。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:PSPath

參數集

LiteralPathParameterSet
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Path

指定通往一個或多個位置的路徑。 允許使用通配符。 預設位置是目前目錄 (.)。

參數屬性

類型:String
預設值:None
支援萬用字元:True
不要顯示:False

參數集

PathParameterSet
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

String

輸出

Object