PowerShell에서 코드를 주석 처리하는 방법은 무엇입니까?


938

PowerShell (1.0 또는 2.0) 에서 코드를 어떻게 주석 처리 합니까?


24
참고 '#'은 bash, python, php, ruby ​​및 powershell과 같은 많은 쉘 및 스크립트 언어 의 주석입니다 .
yzorg

61
이것이 바로# Windows 또는 Microsoft 기반 스크립팅 언어의 주석이 아니라고 가정 한 이유 입니다.
René Nyffenegger

2
다른 모든 기술과 달리 MS는 Powershell에 적절한 참조를 제공하지 않았기 때문입니다. 어디서나 찾을 수 없었습니다.
dudeNumber4

5
@ dudeNumber4 PowerShell에는 모든 언어에 대한 가장 포괄적 인 참조 중 하나가 있습니다. 언어에 기능을 추가하려면 예제, 방법 및 멤버 목록 등이 포함 된 포괄적 인 문서 포함 되어야합니다help .
TylerH

답변:


1250

PowerShell V1에서는 #텍스트 뒤에 주석을 달기 만하면됩니다.

# This is a comment in Powershell

PowerShell V2에서는 <# #>블록 주석, 특히 도움말 주석에 사용할 수 있습니다.

#REQUIRES -Version 2.0

<#
.SYNOPSIS
    A brief description of the function or script. This keyword can be used
    only once in each topic.
.DESCRIPTION
    A detailed description of the function or script. This keyword can be
    used only once in each topic.
.NOTES
    File Name      : xxxx.ps1
    Author         : J.P. Blanc (jean-paul_blanc@silogix-fr.com)
    Prerequisite   : PowerShell V2 over Vista and upper.
    Copyright 2011 - Jean Paul Blanc/Silogix
.LINK
    Script posted over:
    http://silogix.fr
.EXAMPLE
    Example 1
.EXAMPLE
    Example 2
#>
Function blabla
{}

에 대한 자세한 설명은 .SYNOPSIS하고 .*about_Comment_Based_Help을 .

알아두기 :이 기능 코멘트에 의해 사용되는 Get-Helpcmdlet 및 키워드 전에 넣어 수 있습니다 Function, 또는 내부 {}전이나 코드 자체 후.


45
<# #> 블록 주석에 대해 몰랐습니다. 좋은
데니스 G

3
PowerShell v3의 문법은 microsoft.com/en-us/download/details.aspx?id=36389 에서 찾을 수 있습니다 . 섹션을보십시오 B.1.2 Comments.
james.garriss

Send-MailMessage 함수를 백틱으로 사용하여 각 파레 미터를 새 줄에 넣고 그 중 하나를 주석 처리하고 (-Bcc) 다음 줄에서 오류를 일으켰습니다 (-Body : '-Body'라는 용어는 cmdlet 이름으로 인식되지 않습니다 ...) 따라서 함수 호출 중에 줄을 주석 처리하는 것은 지원되지 않는 것 같습니다. 어쩌면 그것은 줄 연속 일 수도 있고, 어쩌면 그것이 작동하지 않을 수도있는 다른 방법 일 수도 있습니다.
Davos

그런 주석은 실제로 인라인이 될 것입니다. 다음과 같이 명령이 구문 분석됩니다. Send-MailMessage -To bob@bob.com # 이것은 주석입니다-제목 "도움말!" 등
CitizenRon

나는 그것이 더 신뢰할 즉시 개통 다음과 같은 기능 주석을 배치 발견했습니다 {( 내부 기능). 특히 스크립트 모듈 기능을 사용하여 외부에서 작동시키는 데 문제가있었습니다.
jpmc26



36

한 줄 주석은 해시 기호로 시작 하며 오른쪽에있는 모든 #것은 무시됩니다.

# Comment Here

PowerShell 2.0 이상에서는 여러 줄 블록 주석을 사용할 수 있습니다.

<# 
  Multi 
  Line 
#> 

블록 주석을 사용하여 명령 내에 주석 텍스트를 포함시킬 수 있습니다.

Get-Content -Path <# configuration file #> C:\config.ini

참고 : PowerShell은 탭 완성 을 지원하므로 Space + TAB주석 전에 복사 및 붙여 넣기에주의해야합니다 .


3
한 줄 내 에서 블록 주석 스타일 사용을 보여주기 위해 +1 . 나는 한 줄에 선언 된 배열의 개별 요소를 일시적으로 주석 처리하는 방법을 찾기 위해 여기에 왔습니다.
Chris Oldwood

17

여기

# Single line comment in Powershell

<# 
--------------------------------------
Multi-line comment in PowerShell V2+ 
-------------------------------------- 
#>

11
기존 답변에 무엇이 추가됩니까?
TZHX

5
간단하고 직접 유지하기
Vic

1
나는 많은 대답들이 영어가 항상 첫 번째 언어는 아니라는 것을 잊어 버리고 실제로 답에 도달하기 전에 그들의 서문에서 너무 장황하고 복잡하게 진행한다고 생각합니다. 이 대답은 우리가 찾고있는 예제로 직접 이동하여 완벽합니다.
Geoff Griswald

15

PowerShell ISE 내에서 Ctrl+ J를 눌러 시작 스니핑 메뉴 를 열고 댓글 블록을 선택할 수 있습니다 .

여기에 이미지 설명을 입력하십시오


새로운 블록 주석이 삽입됩니다. 기존 줄을 주석 처리하지 않습니다.
TylerH

3

당신은 할 수 있습니다:

 (Some basic code) # Use "#" after a line and use:

 <#
    for more lines
    ...
    ...
    ...
    ..
    .
 #>
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.