bash 스크립트로 주석 작성

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

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

Bash 스크립트에 주석을 추가하면 나중에 코드를 볼 때 많은 시간과 노력을 절약 할 수 있습니다. 몇 달 또는 몇 년 전에 작성한 스크립트를 변경한다고 가정 해 봅시다. 주석을 추가하지 않으면 복잡한 코드를 작성한 이유를 기억하지 못할 가능성이 있습니다.

주석은 또한 코드와 코드의 목적을 이해하기 위해 스크립트를 유지 관리해야하는 다른 개발자 및 시스템 관리자에게 도움이됩니다.

주석은 일반적으로 코드가 할 수없는 것을 설명하는 데 사용됩니다. 예를 들어, Bash 스크립트 내에 복잡한 정규식 또는 매개 변수 대체가있는 경우 코드의 기능에 대한 설명을 작성해야합니다. 의견은 짧고 요점을 가리켜 야합니다. 독자에게 간단하고 명백한 것을 설명하지 마십시오.

Bash에서 의견을 작성하는 기본 사항을 다룰 것입니다.

Bash에서 의견 쓰기

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

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

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

해시 표시 뒤의 공백은 필수는 아니지만 주석의 가독성을 향상시킵니다.

일반적으로 텍스트 편집기에서 스크립트를 열면 주석이 녹색으로 표시됩니다.

주석은 스크립트를 테스트 할 때도 유용합니다. 일부 선이나 블록을 삭제하는 대신 주석 처리 할 수 ​​있습니다.

# if]; 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에서 해시 표시 ( # ) 뒤 및 행 끝까지의 모든 것은 주석으로 간주됩니다.

질문이나 의견이 있으시면 언제든지 의견을 남겨주십시오.

bash 터미널