資料結構
網路
關係型資料庫管理系統
作業系統
Java
MS Excel
iOS
HTML
CSS
Android
Python
C 程式設計
C++
C#
MongoDB
MySQL
Javascript
PHP
物理學
化學
生物學
數學
英語
經濟學
心理學
社會學
時尚學
法學如何在 PowerShell 函式中新增幫助？
當我們寫一個程式的時候，那些沒有程式設計背景的人通常希望獲得很多關於這個程式的幫助。當我們編寫一個函式並宣告引數時，那些不知道引數需要何種輸入的人通常會先使用Get-Help命令來搜尋幫助，然後他們只會找到引數，而沒有找到其描述。例如，
function TestFunct{
param(
#16 Digit Application ID
[parameter(Mandatory=$true)]
[String]$AppID,
#Date in the Unix Format - 2020-10-31T17:12:10+0530
[String]$Date
)
}在上面的示例中，指定了兩個引數，當用戶獲得此函式的幫助時，它不會指定提供引數描述的註釋。例如，
PS C:\> help TestFunct -Parameter * -AppID <string> Required? true Position? 0 Accept pipeline input? false Parameter set name (All) Aliases None Dynamic? false -Date <string> Required? false Position? 1 Accept pipeline input? false Parameter set name (All) Aliases None Dynamic? false
要從註釋中新增描述，我們需要新增基於註釋的幫助，並需要使用基於註釋的幫助中的SYNOPSIS。
示例
function TestFunct{
<#
.SYNOPSIS
This is test function for parameter based help
#>
param(
#16 Digit Application ID
[parameter(Mandatory=$true)]
[String]$AppID,
#Date in the Unix Format - 2020-10-31T17:12:10+0530
[String]$Date
)
}現在我們檢查引數時，會得到基於註釋的描述。
PS C:\> help TestFunct -Parameter * -AppID <String> 16 Digit Application ID Required? true Position? 1 Default value Accept pipeline input? false Accept wildcard characters? false -Date <String> Date in the Unix Format - 2020-10-31T17:12:10+0530 Required? false Position? 2 Default value Accept pipeline input? false Accept wildcard characters? false
更新時間：2020 年 11 月 2 日
303 次瀏覽
廣告