Linux : Bash Scripts에 주석 작성 방법, 예제, 명령어

Bash 스크립트를 작성할 때는 항상 코드를 깨끗하고 쉽게 이해할 수 있도록 하는 것이 좋습니다. 코드를 블록으로 구성하고, 들여쓰기를 하고, 변수와 함수에 설명 이름을 붙이는 것은 여러 가지 방법입니다.

코드의 가독성을 향상시키는 또 다른 방법은 주석을 사용하는 것입니다. 설명은 셸 스크립트로 작성된 사람이 읽을 수 있는 설명 또는 주석입니다. 

Bash 스크립트에 주석을 추가하면 향후 코드를 확인할 때 많은 시간과 노력을 절약할 수 있습니다. 몇 달이나 몇 년 전에 쓴 대본을 바꾸고 싶다고 가정해 보겠습니다. 코멘트를 추가하지 않는 한 복잡한 코드를 작성한 이유를 기억하지 못할 가능성이 있습니다.

또한 설명을 통해 스크립트를 유지관리해야 하는 다른 개발자와 시스템 관리자가 사용자의 코드와 목적을 파악할 수 있습니다.

설명은 코드를 설명하는 데 사용됩니다. 예를 들어, Bash 스크립트 내에 복잡한 정규식 또는 매개 변수 대체가 있는 경우 코드의 기능을 설명하는 주석을 작성해야 합니다. 코멘트는 짧고 요점만 적어야 합니다. 독자에게 간단명료한 것은 설명하지 마세요.

Bash에서 코멘트를 작성하는 기본 사항에 대해 다룰 것입니다.

 

 

Linux : Bash Scripts에 주석 작성 방법, 예제, 명령어

 

 

Bash에서 코멘트 쓰기 

Bash는 해시 표시(#) 뒤에 있는 줄에 쓰여진 모든 내용을 무시합니다. 이 규칙에 대한 유일한 예외는 스크립트의 첫 번째 줄이 #! 문자로 시작하는 경우입니다. 이 문자 시퀀스를 Shebang이라고 하며 운영 체제에 파일의 나머지 부분을 구문 분석하는 데 사용할 인터프리터를 알려주는 데 사용됩니다.

주석은 줄의 시작 부분에 추가하거나 다른 코드와 함께 인라인으로 추가할 수 있습니다.

# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.

 

 

해시 표시 뒤의 공백은 필수 사항은 아니지만 설명 가독성이 향상됩니다.

텍스트 편집기에서 구문 강조 표시를 지원하는 경우 주석은 일반적으로 녹색으로 표시됩니다.

주석은 스크립트를 테스트할 때도 유용합니다. 일부 행 또는 블록을 삭제하는 대신 주석을 달 수 있습니다.

# if [[ $VAR -gt 10 ]]; then
#  echo "Variable is greater than 10."
# fi

 

 

 

Bash의 여러 줄 주석

대부분의 프로그래밍 언어와 달리 Bash는 여러 줄 주석을 지원하지 않습니다.

Bash에서 여러 줄의 주석을 작성하는 가장 간단한 방법은 주석을 하나씩 추가하는 것입니다.

# This is the first line.
# This is the second line.

 

 

다른 옵션은 HereDoc을 사용하는 것입니다. 여러 줄의 입력을 명령에 전달할 수 있는 리디렉션 유형입니다. HereDoc 블록이 명령으로 리디렉션되지 않은 경우, 다중 줄 주석 플레이스홀더 역할을 할 수 있습니다.

<< 'MULTILINE-COMMENT'
    Everything inside the
    HereDoc body is
    a multiline comment
MULTILINE-COMMENT

 

 

HereDoc을 사용하는 것은 해킹이지 여러 줄의 Bash 주석을 작성하는 실제 기본 방식이 아닙니다. 문제를 방지하려면 한 줄 주석을 사용하는 것이 좋습니다.

코멘트를 작성하는 것은 좋은 관행이며 미래의 자신을 포함한 다른 개발자들이 셸 스크립트를 이해하는 데 도움이 됩니다. Bash에서는 해시 표시(#) 이후의 모든 항목 및 줄 끝까지를 주석으로 간주합니다.