☰

함수 앞이나 함수 내부의 Bash 함수 주석

tag-icon • tag-icon bash shell-script shell
함수 앞이나 함수 내부의 Bash 함수 주석

Bash 언어에는 함수에 대한 주석이 함수 앞에 배치되어야 하는지 아니면 함수 내부에 배치되어야 하는지를 규정하는 표준이 있습니까? 나는 두 가지 방법으로 작성된 스크립트를 본 적이 있습니다.

# Comment preceding function.
func1(){
echo "example"
}

-또는-

func2() {
# Comment inside of function
echo "example"
}

답변1

대부분의 프로그래밍 언어에서는 함수가 수행하는 작업을 설명하는 주석이 함수 앞에 옵니다. 아마도 bash에서도 같은 작업을 수행해야 할 것입니다. 들여쓰기도 사용해야 합니다.

# function 1 comment
func1() {
    echo "example"
}

답변2

이것예공식에서배쉬 저장소논평앞으로함수 헤더도 마찬가지입니다. https://github.com/scop/bash-completion.

지금으로부터 6개월 후에 리팩토링할 사람(아마도 당신)이 해독하기 매우 쉬운 한 그것은 중요하지 않다고 생각합니다.

셸에서 주석을 추가하는 또 다른 방법은 다음과 같습니다.

:<<'DOC'
My 
multi 
line
comment
DOC

들여 쓰기그리고일관성또한 일반적으로 가지고 있으면 좋습니다.

관련 정보