Re: [shell-script] Formatação nos scripts

[Marlon Vagner Reck]

Amigo 

Acho que a melhor forma seria vc escrever eles de forma q vc entenda eles 
mesmo depois de 20 anos ou mais.
Eles precisam ser bonitos aos olhos, eficazes e fáceis de se dar manutenção, 
tipo cabeçario explicando o q o programa faz e exemplos de como usa-lo, 
comentários diretos e simples nas linhas onde vc acha necessário.
Abaixo segue alguns pedaços de um script meu.

Cabeçario:

#!/bin/bash

#######################################################
#                       sargIndex
#
#Um programa para atualizar as index do Sarg através dos arquivos compactados
#pelo tar.gz
#
#Exemplo de uso: ./sargIndex logSarg_170708.tar.gz
#
#As únicas configurações nescessárias são os locais dos arquivos: 
#DIR_SALVO= local onde foi salvo o arquivo de log compactado.
#DIR_DIARIO= local onde estão os arquivos dos logs diários do sarg.
#DIR_SEMANA= local onde estão os arquivos dos logs semanais do sarg.
#
#Criado em: 18/07/2008
#
#Atualizado por Marlon: 21/07/2008 (Corrigido o erro ao tentar mover mais de
# uma pasta). 
#Atualizado por Marlon: 22/07/2008 (Corrigido o erro da falta do arquivo 
index).
#
#Autor: Marlon Reck
#mail: address@hidden
#Licença: GPL
########################################################


Linhas com comentários:

#Váriaveis globais
ARQUIVO="$1"
DIR_SALVO=/mnt/hd/log/
DIR_DIARIO=/mnt/hd/wwwroot/diario/
DIR_SEMANA=/mnt/hd/wwwroot/semana/
#Fim das váriaveis globais

....................

#move os diretórios data(17jul2008-17jul2008) para o diretório da 
        #váriavel DIR_DIARIO, o xargs aqui se compara ao find -exec.
                ls |egrep [-*]|xargs -I {} mv -f {} "$DIR_DIARIO"

.......................

Espero q estas linhas acima tenham ajudado e desculpem se o e-mail ficou 
grande.
Ps. o script completo vai ficar aqui um mês : 
http://pastebin.com/m604ff8fa

Marlon V. Reck


Em Wednesday 30 July 2008 15:15:50 Tiago Barcellos Peczenyj escreveu:
> Sempre escreva os seus scripts como se quem fosse usar e dar
> manutenção no futuro fosse um psicopata que sabe aonde vc mora.
>
> changelog? dependendo da complexidade é util.
> comentários? quando esclarecem são otimos
> identação: obrigatorio!
>
> 2008/7/30 Raul Libório <address@hidden>:
> > Cara, pelo que sei, uma boa prática é sempre seguir as identações,
> > colocar um changelog e dizer pra que serve o script no cabeçalho.
> > Ai vc pode ir comentando o script com um padrão que você costuma
> > utilizar, tipo, antes de um comando extenso, vc comentar o que ele vai
> > fazer.... Vá simplifiquando a leitura de quem não conhece a função do seu
> > script.
> >
> > abs!""
> >
> > --
> >
> > Raul Libório
> > UniJorge Redes - www.redesfja.com
> > rauhmarutsªhotmailºcom
> > Linux user#4444581
> > [(55) 71] 9246 9828
> > / `
> > /
> > .------.
> >
> > |"""""""|
> > |Linux |
> > |inside|
> >
> > `--------'
> > Dúvidas: enviar para /dev/null .
> > Respondei assim que possível."
> > _____________________________
> > "Nada se cria, tudo se compila."
> >
> > 2008/7/30 Alicino De Moura Filho <address@hidden>
> >
> >> Colegas,
> >>
> >> Alguém poderia indicar um site ou algo que ajude a explicitar sobre a
> >> formatação nos scripts que criamos?
> >>
> >> Digo isso, pq as vezes visualmente não fica legal e fico me perguntando
> >> se existe uma "regra", mesmo que informal para isso.
> >>
> >> Abs!
> >>
> >> Alicino de Moura Filho
> >> address@hidden <alicino%40ymail.com>
> >> http://www.alicino.eng.br/
> >> Campinas-SP
> >>
> >> --+ Mens In Corpore Tantum Molem Regit +--
> >>
> >> [As partes desta mensagem que não continham texto foram removidas]
> >
> > [As partes desta mensagem que não continham texto foram removidas]



-- 
Desde já agradeço.
Marlon V. Reck