Help Information: 주석 추가하기

jy17·2022년 5월 24일

PowerShell

목록 보기

3/3

0. 환경

OS: Windows 10
PSVersion(Powershell Version): 5.1.19041.1645

1. 목적

함수에 대한 주석을 효율적으로 작성하기 위함

2. 핵심

아래 태그들을 이용하면 Get-Help cmdlet을 이용해서 해당 함수 검색 시, 기존 Windows cmdlet들이 지원하는 것처럼 만들 수 있음

3. Help Tags(일부)

Tag Name	Description
.SYNOPSIS	함수 또는 스크립트에 간략한 설명, 키워드는 한번만 사용 가능
.DESCRIPTION	함수 또는 스크립트에 대한 자세한 설명, 키워드는 한번만 사용 가능
.PARAMETER	매개 변수에 대한 설명
.EXAMPLE	함수 또는 스크립트를 사용하는 샘플 명령
.INPUTS	함수 또는 스크립트에 파이프할 수 있는 개체의 .NET 형식
.OUTPUTS	cmdliet이 반환하는 개체의 .NET 형식
.NOTES	함수 또는 스크립트에 대한 추가 정보
.LINK	관련 항목이며, 링크 섹션을 다는데 사용할 수 있음
.COMPONENT	함수 또는 스크립트가 사용하는 관련된 기술 또는 기능의 이름
.ROLE	도움말 항목의 사용자 역할 이름
.FUNCTIONALITY	함수의 의도된 사용을 설명하는 키워드

4. 템플릿

개인적으로 자주 사용할 것으로 예상되는 템플릿
{간단 설명, 상세 설명, 파라미터 설명, 예제, 출력}으로 구성됨

    <#
        .SYNOPSIS

        .DESCRIPTION

        .PARAMETER param1

        .PARAMETER param2

        .PARAMETER param3
        
        .OUTPUTS

        .EXAMPLE
    #>

5. 예제

1) 샘플 코드 작성

function Add-UserInfo
{
    param ([string]$name,[string]$age,[string]$user_id)
    $user_info = $name + "\t" + $age + "\t" + $user_id

    <#
        .SYNOPSIS
        사용자를 추가

        .DESCRIPTION
        입력받은 정보를 바탕으로 '사용자이름\t나이\t아이디'로 구성된 정보를 생성

        .PARAMETER name
        사용자 이름을 지정

        .PARAMETER age
        나이를 지정

        .PARAMETER user_id
        사용자 id를 지

        .OUTPUTS
        '사용자이름\t나이\t아이디'을 반환

        .EXAMPLE
        PS> Add-UserInfo -name "hankey" -age "8" -id "mas"
        File.txt
    #>
}