Jedi Tux

Comentando Um Programa

Posted in Python by Fernando Basso on 8 de setembro de 2009

Comentários servem para ‘comentar’ o código fonte, e ajudar a lembrar o que o código faz. Não são mostrados na saída padrão. Use comentários habitualmente. É o que grandes programadores fazem. O Kernel Linux por exemplo, está repleto de comentários. É importante usa-los, pois assim fica fácil entender o código posteriormente, para modificar, corrigir bugs, ou adicionar features e melhorias no porgrama. Veja:

print(2 + 2) # Mostra o produto de 2 + 2.

Claro que este é um exemplo simples, mas dá pre ‘pegar’ a idéia.

Comentários devem ser curtos para não poluírem demais o código porém devem ser informativos e diretos.

É melhor que não haja comentário algum, do que um comentário errado,
que não condiga com o que o código realmente faz. Se modificar uma
parte do código que estava comentada, atualize o comentário de acordo
com o novo código. Não deixe pra depois.

Comentários se tornam imprescindíveis, principalmente em partes complexas do código. Neste caso, é muito que explique com clareza (mas sempre tentando ser direto) o que está acontecendo naquele pedaço de código, mesmo que não fique tão curto.
IMPORTANTE:
Por favor, USE COMENTÁRIOS EM SEUS PROGRAMAS. Mesmo que sejam só estudos. COMENTAR O CÓDIGO É UMA ARTE (assim como programar). É preciso ter muito feeling pra saber o que escrever e o que NÃO escrever.
Torne isto um hábito. Pense em comentários como amigos que te livrarão de perder horas tentando decifrar o que faz um pedaço de código. Sem contar, que estará ajudando outros que lerem o seu código, e até mesmo pessoas aprendendo a programar.

Deixe uma resposta

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: