programing

PowerShell의 코드를 어떻게 코멘트합니까?

magicmemo 2023. 4. 16. 14:52
반응형

PowerShell의 코드를 어떻게 코멘트합니까?

PowerShell(1.0 또는 2.0)에서 코드를 코멘트 아웃하려면 어떻게 해야 합니까?

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그리고..*_Comment_Based_Help에 대해 참조하십시오.

비고: 이러한 기능의 코멘트는,Get-HelpCmdLet 및 키워드 앞에 배치할 수 있습니다.Function또는 내부{}코드 이전 또는 이후입니다.

해시 마크는 다음과 같이 사용합니다.

# This is a comment in PowerShell

Wikipedia에는 몇 가지 일반적인 언어로 코멘트를 하는 방법을 추적하기 위한 좋은 페이지가 있습니다.

평.

한 줄 코멘트는 해시 기호로 시작합니다.모두 오른쪽입니다.#무시됩니다.

# Comment Here

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

<# 
  Multi 
  Line 
#> 

블록 코멘트를 사용하면, 커맨드내에 코멘트 텍스트를 포함할 수 있습니다.

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

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

바로 그#.

특수 문자는 PowerShell - 특수 문자와 토큰을 참조하십시오.

PowerShell ISE에서 +를 J눌러 캡처 시작 메뉴를 열고 주석 블록을 선택할 수 있습니다.

여기에 이미지 설명 입력

여기서

# Single line comment in PowerShell

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

해시태그 뒤에 공백(!)을 사용합니다.

 # Comment here

여기 여백을 잊지 마세요!그렇지 않으면 내부 명령이 간섭될 수 있습니다.

예: 이것은 코멘트가 아닙니다.

#requires -runasadmin

파티에 조금 늦었지만 실제로 모든 사용 사례를 작성한 사람은 없는 것 같습니다.그래서...

현재 지원되는 PowerShell 버전은 다음과 같습니다(2020년 가을 이후).

  • Windows PowerShell 5.1.x
  • PowerShell 7.0.x

다른 버전의 PowerShell을 사용하지 않거나 사용하지 않는 것이 좋습니다.

버전 모두(또는 일부 오래된 스테이션에서는 WPS 3.0-5.0, PS Core 6.x.x 에 부속되어 있는 다른 버전도) 같은 코멘트 기능을 공유하고 있습니다.

한 줄 코멘트

# Get all Windows Service processes <-- one line comment, it starts with '#'
Get-Process -Name *host*

Get-Process -Name *host* ## You could put as many ### as you want, it does not matter

Get-Process -Name *host* # | Stop-Service # Everything from the first # until end of the line is treated as comment

Stop-Service -DisplayName Windows*Update # -WhatIf # You can use it to comment out cmdlet switches

여러 줄의 코멘트

<#
Everyting between '< #' and '# >' is
treated as a comment. A typical use case is for help, see below.

# You could also have a single line comment inside the multi line comment block.
# Or two... :)

#>

<#
.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
    Some additional notes. This keyword can be used only once in each topic.
    This keyword can be used only once in each topic.

.LINK
    A link used when Get-Help with a switch -OnLine is used.
    This keyword can be used only once in each topic.

.EXAMPLE
    Example 1
    You can use this keyword as many as you want.

.EXAMPLE
    Example 2
    You can use this keyword as many as you want.
#>

중첩된 여러 줄 주석

<#
Nope, these are not allowed in PowerShell.

<# This will break your first multiline comment block... #>
...and this will throw a syntax error.
#>

코드 중첩된 여러 줄 주석

<#
The multi line comment opening/close
can be also used to comment some nested code
or as an explanation for multi chained operations..
#>
Get-Service | <# Step explanation #>
Where-Object { $_.Status -eq [ServiceProcess.ServiceControllerStatus]::Stopped } |
<# Format-Table -Property DisplayName, Status -AutoSize |#>
Out-File -FilePath Services.txt -Encoding Unicode

엣지 케이스 시나리오

# Some well written script
exit
Writing something after exit is possible but not recommended.
It isn't a comment.
Especially in Visual Studio Code, these words baffle PSScriptAnalyzer.
You could actively break your session in VS Code.

다음 작업을 수행할 수 있습니다.

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

 <#
    for more lines
    ...
    ...
    ...
    ..
    .
 #>

주석을 삽입하고 스크립트의 끝을 추가하는 특별한 방법이 있습니다.

....
exit 

Hi
Hello
We are comments
And not executed 

그 이후의 모든 것exit는 실행되지 않으며 댓글과 같이 동작합니다.

언급URL : https://stackoverflow.com/questions/7342597/how-do-you-comment-out-code-in-powershell

반응형