Início / coding / Perguntas / 79188872
Accepted
Jared Frazier
Asked: 2024-11-14 21:05:18 +0800 CST

Imprimindo o corpo da função bash e incluindo os comentários no corpo

  • 772

Estou usando shdoc para gerar arquivos markdown para minhas funções bash; no entanto, gostaria de anexar também o corpo da função bash associada , bem como os comentários nesse corpo, ao arquivo markdown gerado por shdoc. Como posso imprimir um corpo de função bash e, ao mesmo tempo, incluir os comentários no corpo da função?

Como um exemplo simples, considere que todos os meus arquivos bash estão contidos em um diretório chamado srce todos esses arquivos terminam em .sh. A função abaixo no arquivosrc/foo.sh

# @description A function that does something
foo() {
  # oh wow, a comment
  echo "something cool"
}

Agora, se eu quiser obter o corpo da função sem comentários, posso fazer isso facilmente, declare -fconforme mostrado abaixo, em um arquivo chamado src/doc.sh:

# assuming you are in the `src` dir and both .sh files are executable
. foo.sh
foo_doc=$(declare -f foo)
echo "$foo_doc"

Mas o problema é foo_docque só tem a função body, já queecho "$foo_doc"

foo () 
{ 
    echo "something cool"
}

e nenhum comentário. Então, se eu fosse anexar essas informações a um markdown gerado por shdoc, não seria uma documentação ideal do código-fonte.

Acho que uma abordagem seria usar sedpara determinar as linhas correspondentes à função de interesse (minhas funções bash são "delimitadas" por {e }, embora, pelos comentários, eu entenda que há outras maneiras de declarar funções bash válidas), então eu poderia usar sedpara obter apenas essas linhas, como feito aqui .

bash

2 respostas

  1. É um pouco complicado, mas você pode usar comentários com dois pontos:

    foo() {
    : This is a comment
    echo foo this bar
}

    Explicação: :em bash é um comando no-op. Você pode passar a ele quaisquer argumentos que quiser, e ele os ignora. Então esse "comentário" é, na verdade, tecnicamente um comando que faz parte do corpo da função que não faz nada. Você tem que ter cuidado, porém, se seus comentários incluírem caracteres especiais, você terá que colocá-los entre aspas.

    • 2
  2. Best Answer

    Como você tem acesso aos arquivos que contêm as definições de função, você pode fazer isso com qualquer awk POSIX:

    awk '
    /^[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(/ && ($1 !~ /^(if|elif|for|while|until)$/) {
        inFunc = 1
    }
    inFunc {
        print
        if ( /^[})]/ ) {
            inFunc = 0
        }
    }
' src/*.sh

    Não é 100% robusto, mas provavelmente será bom o suficiente para suas funções se elas se parecerem com o exemplo que você forneceu (ou seja, começar com alphanumeric_name (no início de uma linha e terminar com }ou )no início de uma linha) e você não tiver nenhum outro código em seus scripts que também se pareça com isso, mas não seja uma definição de função.

    Adicione mais palavras-chave ao $1 !~teste, se desejar, ou você pode torná-lo mais robusto adicionando uma chamada declare -Fe aceitando somente definições de função aparentes correspondidas pela expressão regular acima se a string corresponder a uma definição de função real, conforme relatado por declare -F.

    Por exemplo:

    $ cat src/tst.sh
# The following is a function
# that does amazing things.
foo() {
  # oh wow, a comment
  echo "something cool"
}

# other code
if (( $# > 1 )); then
    echo "Eureka"
fi

# This function, however, is
# useless, can't believe we
# bothered to write it.
bar() {
  # this sucks
  # hope it doesn't get called
  echo "the sky is falling"
}


    $ . src/tst.sh


    $ declare -f foo bar
foo ()
{
    echo "something cool"
}
bar ()
{
    echo "the sky is falling"
}


    $ declare -F foo bar
foo
bar


    $ declare -F |
awk '
    NR == FNR {
        funcs[$3]
        next
    }
    /^[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(/ && ($1 in funcs) {
        inFunc = 1
    }
    inFunc {
        print
        if ( /^[})]/ ) {
            inFunc = 0
        }
    }
' - FS='[[:space:](]+' src/*.sh
foo() {
  # oh wow, a comment
  echo "something cool"
}
bar() {
  # this sucks
  # hope it doesn't get called
  echo "the sky is falling"
}

    e se você quiser obter comentários que terminem na linha imediatamente antes de cada função também:

    $ declare -F |
awk '
    NR == FNR {
        funcs[$3]
        next
    }
    /^[[:alpha:]_][[:alnum:]_]*[[:space:]]*\(/ && ($1 in funcs) {
        printf "%s", cmt
        inFunc = 1
    }
    { cmt = (/^#/ ? cmt $0 ORS : "") }
    inFunc {
        print
        if ( /^[})]/ ) {
            print ""
            inFunc = 0
        }
    }
' - FS='[[:space:](]+' src/*.sh
# The following is a function
# that does amazing things.
foo() {
  # oh wow, a comment
  echo "something cool"
}

# This function, however, is
# useless, can't believe we
# bothered to write it.
bar() {
  # this sucks
  # hope it doesn't get called
  echo "the sky is falling"
}

    Observe que isso imprimirá apenas as funções definidas em seus arquivos e que estão disponíveis em seu ambiente, diferentemente do primeiro script, que imprimirá todas as funções em seus arquivos.

    • 2

relate perguntas