2011-09-09 4 views
3

.PARAMETER 옵션을 사용하여 함수의 매개 변수에 대한 자세한 정보를 추가 할 때 어떻게 도움을 줍니까? ".PARAMETER $ ParamName"시도했는데 작동하지 않았고 ".PARAMETER -ParamName"을 시도했지만 어느 것도 작동하지 않았습니다. 여기 PowerShell 도움말을 작성할 때 .PARAMETER를 어떻게 사용합니까?

은 예입니다 :

<# 

.SYNOPSIS 
short overview 

.DESCRIPTION 

longer overview 

.PARAMETER 

dont know how this works? 

.EXAMPLE 

Example code 

.NOTES 

This is awesome! 

.LINK 

http://winfred.com 
#> 

답변

4

그 복잡하지, 당신은 단순히 그것을 사용 등 : 또한

.PARAMETER MyParam 
    MyParam does whatever bla bla bla... 
+3

다음을 참조하십시오 :'도움 – Rynant

+2

about_Comment_Based_Help' 예를 들어

.PARAMETER NameOfParam Description of param 

(선호하는) 변형은 매개 변수 정의 바로 위에 설명 주석을 넣는 것입니다. 그러면 자동으로 도움말 텍스트에 매개 변수 설명으로 포함됩니다. –

관련 문제