Os comentários no código é importante para ajudar a compreender o seu código e de outros colegas programadores.
O comentário com aspas triplas pode gerar documentação e passa a aparecer em help( ) do IDLE que vimos no post sobre print()
Comentário de uma linha
|
1 |
# Comentário de uma linha |
Comentário de multiplas linhas
|
1 2 3 4 5 |
""" Comentário de mais de uma linha """ |
Comentário usado para gerar documentação
|
1 2 3 4 5 |
def function soma(a,b): """ Soma dois números 'a' e 'b' """ return a + b |
Para gerar documentação deverá instalar a biblioteca pydoc
Depois deverá executar:
pydoc -p 1234
Que cria uma documentação em html do projeto com base nos comentários de três aspas em suas funções e objetos.