PREPARAR DOCUMENTAÇÃO

1. PREPARAR DOCUMENTAÇÃO

raulcastro
(usa Fedora)

Enviado em 20/07/2012 - 11:26h

olá pessoal,

gostaria de saber se existe algum padrão para realizar a documentação dos scripts, alguém poderia me passar alguma apostila, pois desejo realizar a documentação dos meus scripts!

muito obrigado desde já

0 0

Quote

2. Re: PREPARAR DOCUMENTAÇÃO

rai3mb
(usa Outra)

Enviado em 20/07/2012 - 11:39h

Não há, o que existem são recomendações assim como nas demais linguagens, se já está acostumado com alguma outra linguagem, basta seguir o mesmo padrão.

Uma dica é olhar os scripts do http://aurelio.net/, ele tem boas dicas de documentação, como sempre fazer um RoadMap do que seu script vai fazer, etc.

Abraços e parabéns bela atitude, sempre é bom encontrar código bem documentado.

0 0

Quote

3. Obrigado

raulcastro
(usa Fedora)

Enviado em 20/07/2012 - 14:55h

rai3mb escreveu:

Não há, o que existem são recomendações assim como nas demais linguagens, se já está acostumado com alguma outra linguagem, basta seguir o mesmo padrão.

Uma dica é olhar os scripts do http://aurelio.net/, ele tem boas dicas de documentação, como sempre fazer um RoadMap do que seu script vai fazer, etc.

Abraços e parabéns bela atitude, sempre é bom encontrar código bem documentado.

Muito obrigado, eu sempre gostei de códigos bem documentados, por motivos que estamos cansado de saber.
acho que para ser um bom programador tem que se preocupar bastante com a documentação tbm.

0 0

Quote