Documentação de scripts python

Se necessitar imprimir em um script python, caso o mesmo seja chamado diretamente, sua documentação o jeito simples seria:


if __name__=="__main__":
__doc__



Já cheguei a ver pessoas utilizando uma função main() só para
imprimir a documentação do módulo, mas assim como __name__ está
disponível para testes, de forma similar __doc__ está disponível para
imprimir a documentação e o velho usage:

Portanto coloque na docstring do módulo sua descrição e
como usar-lo, desfrutando a uma só vez das duas coisas :) .

Nenhum comentário:

Postar um comentário

Insira seu comentário - O mesmo será submetido à aprovação!

linux-cookbook

Grupos do Google
Participe do grupo linux-cookbook
E-mail:
Visitar este grupo