Como posso adicionar um comentário para cada sinalizador, em linhas separadas, em um script bash?

Question

Eu quero escrever scripts bash que sejam tão documentados quanto possível.

Eu tive uma idéia que quando eu executo software com muitos flags, eu queria dividir o comando em várias linhas, e adicionar um comentário no final de cada linha, dizendo o que a bandeira faz (informações de uma página man) assim:

bwa aln \
-n $n \ # -n max #diff (integer) or missing prob under 0.02 err rate (float) [0.04]
-o $o \ # -o maximum number or fraction of gap opens [1]
-e $e \ # -e maximum number of gap extensions, -1 for disabling long gaps [-1]
-i $i \ # -i do not put an indel within integer bp towards the ends [5]
-d $d \ # -d maximum occurrences for extending a long deletion [10]
-l $l \ # -l seed length [32]
-k $k \ # -k maximum differences in the seed [2]
-m $m \ # -m maximum entries in the queue [2000000]
-t $t \ # -t number of threads [1]
-M $M \ # -M mismatch penalty [3]
-O $O \ # -O gap open penalty [11]
-E $E \ # -E gap extension penalty [4]
-R $R \ # -R stop searching when there are >integer equally best hits [30]
-q $q \ # -q quality threshold for read trimming down to 35bp [0]
-f $f \ # -f file to write output to instead of stdout
-B $B \ # -B length of barcode
-L $L \ # -L log-scaled gap penalty for long deletions
-N $N \ # -N non-iterative mode: search for all n-difference hits (slooow)
-I $I \ # -I the input is in the Illumina 1.3+ FASTQ-like format
-b $b \ # -b the input read file is in the BAM format
-0 $0 \ # -0 use single-end reads only (effective with -b)
-1 $1 \ # -1 use the 1st read in a pair (effective with -b)
-2 $2 \ # -2 use the 2nd read in a pair (effective with -b)
-Y $Y \ # -Y filter Casava-filtered sequences
-prefix $prefix \ # -prefix Prefix
-inputfile $inputfile \ # -inputfile Input file (FastQ format)

O problema é que eu não posso ter nada após o caractere \ (que diz bash que o comando continua na próxima linha), e nem eu posso ter o "\" no final da linha, porque então ele é tratado como parte do comentário.

Alguém sabe uma maneira de fazer isso, ou algo similar?

    

Answer 1

Você pode avaliar comentários antes da barra, simplesmente gerando strings vazias para comentários que não afetarão seu script:

bwa aln \
-n $n '# -n max #diff (integer) or missing prob under 0.02 err rate (float) [0.04]' \
-o $o '# -o maximum number or fraction of gap opens [1]' \
....

    

Answer 2

Sugiro usar várias linhas para comentar o código antes do comando. como

 # this command uses multiple parameters
 # it requires 4 parameters and none are optional with no defaults
 # parameters used : 
 # -q              name of the file
 # -b              size to truncate
 # -n              new location
 # -r              recursive

    

Answer 3

Uma opção é construir seu comando em partes para que você não precise se preocupar com a continuação da linha:

cmd='date'                # run the date program
cmd=${cmd}' -d 20130905'  #  for this date
cmd=${cmd}' +%s'          #  with output in this format
echo $cmd                 # review the command
eval $cmd                 # run the command