Comentários da função Bash antes ou dentro da função [closed]

Question

A linguagem Bash tem um padrão que determina se os comentários sobre a função devem preceder a função ou ser inseridos nela. Eu vi scripts escritos dos dois lados.

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

-ou -

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

    

Answer 1

Na maioria das linguagens de programação, os comentários descrevem o que a função faz antes da função. Você provavelmente deveria fazer o mesmo por bash. Você também deve usar o recuo:

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

    

Answer 2

Os exemplos do funcionário bash repo comentário antes o cabeçalho da função e o mesmo acontece link .

Eu não acho que importe muito, contanto que seja fácil decifrar a pessoa que estará refatorando-a daqui a seis meses (o que pode ser você).

Aqui está outra maneira de comentar em shells:

:<<'DOC'
My 
multi 
line
comment
DOC

Recuo e consistência também são bons.