Re: [shell-script] [OT] Como documentar funções feitas no Shell?

[Guilherme Ulbrich]

Assim eu acho que fica bom..... sugestão....



AchaNaMatriz(){
#
# Função para procurar registros em uma matriz.
#
# Uso: AchaNaMatriz Matriz Registro [A_partir_Do_Indice_X]
#
# Retorna 0 para encontrado e 1 para não encontrado.
#
#

        local MATRIX=()
        local REG_BUSCA=
        local x=

        x=${3:-0}

        eval "MATRIX=( \${$1[*]} )"
        REG_BUSCA="$2"

        for (( i=x;i<${#MATRIX[*]};i++ ));do
                if [ ${MATRIX[$i]} == $REG_BUSCA ];then
                        return 0
                fi
        done
        return 1

}



CriaObstaculosVertical(){
# Cria uma Coluna de Obstáculos e armazena na matriz OBSTACULOS
#
# Uso: CriaObstaculosVertical Linha_Inicio Linha_Final Coluna [Char_Obst]
#

        local x=
        local linha_inicial=
        local char_obstaculo=${4:-"\033[7m \033[m"} # Espaço com cor 
invertida....

        for ((x=$1;x<$2;x++));do
                echo -ne "\033[${x};${3}H$char_obstaculo" # \033[x,yH -- 
gotoxy()
                OBSTACULOS[${#OBSTACULOS[*]}]="$x;$3"
        done
        
}





2006/6/27, Murilo Opsfelder Araújo <address@hidden>:
>
> Olá pessoal,
>
> alguém aí tem alguma técnica de como documentar shell scripts?
>
> Pode ser aquele 'modelinho de comentário' que vc utiliza pra ficar
> tudo bonitinho.
>
> Estou escrevendo esse e-mail pois não tenho noção por onde começar.
>
> Grande abraço à todos.
>
> --
> Murilo Opsfelder Araújo
> Linux User #391561
> ./murilo --opsfelder='araujo'
> 
>


[As partes desta mensagem que não continham texto foram removidas]