Nesta aula estudaremos a utilização de comentários em Python, onde e o que devemos comentar e diversas outras questões pertinentes ao uso de comentários junto ao código fonte. |
COMENTÁRIOS
O uso de comentários é uma prática normal na programação. O objetivo é poder adicionar descrições em partes especificas do código, seja para documentá-lo, seja para adicionar uma descrição, ou mesmo, para marcar que uma determinada linha, ou um conjunto de linhas, não devem ser executados.
Para adicionarmos comentários, utilizamos uma notação especial, a fim de informar ao interpretador que, determinado trecho de caracteres, possui a finalidade de descrever ou documentar algo e assim, o compilador ou interpretador, não deve interpretar os caracteres contidos na notação que demarca trechos de comentários.
A NOTAÇÃO DEFINIDA PELO PYTHON
Em Python, temos 3 notações utilizadas para definir blocos de comentários. A primeira e mais simples, é para definirmos que uma única linha deve ser ignorada, e as 2 outras, para delimitarmos um conjunto de linhas.
NOTAÇÃO INLINE
Utilizamos o caractere cerquilha # para demarcarmos que tudo que estiver a frente desse caractere, deve ser ignorado pelo interpretador do Python, por exemplo:
#coding: utf-8
#tudo que estiver a frente da cerquilha será ignorado
print(teste) #a instrução atrás da cerquilha será interpretada
NOTAÇÃO MULTILINES (VÁRIAS LINHAS)
A linguagem Python também disponibiliza uma notação para demarcarmos que um conjunto de linhas deve ser ignorado pelo interpretador. Essa notação se dá pelo uso de 3 aspas simples, ou entao, 3 aspas duplas. Nestes casos, tudo que estiver delimitado pelas aspas não será interpretado, por exemplo:
#coding: utf-8
'''
toda informações contida entre 3 aspas SIMPLES
é considerada como caracteres que devem ser ignorados.
'''
toda informações contida entre 3 aspas DUPLAS
é considerado texto que deve ser ignorado.
No código acima, definimos 2 blocos de códigos que serão ignorados pelo interpretador do Python ou então, podemos dizer que, serão interpretados como se fossem comentários e que dispensam qualquer avaliação por parte do interpretador.
PARA QUE UTILIZAMOS COMENTÁRIOS?
A utilização de comentários da-se tanto para inserirmos uma informações que não podemos esquecer, ou então, algo que desejamos que outros programadores saibam no momento em que estiverem lendo determinadas linhas de código.
A primeira utilização dos comentário é fazer o que o próprio nome sugere: comentar os nosso códigos informando ao interpretador que essas linhas não devem ser executadas.
DOCUMENTAÇÃO DE PROGRAMAS
Utilizamos a marcação de comentários para documentarmos programas, classes, funções, variáveis, constantes ou seja lá o que for. Quando criamos uma biblioteca e essa será utilizada por terceiros, é importante que o código possua uma documentação para que os outros programadores entendam a nossa biblioteca e, saibam como invocar as funções corretamente, ou mesmo, para entenderem o que elas se propõem.
Para a documentação de código, há um conjunto de parâmetros a serem definidos dentro do bloco de comentário a fim de instruir o programa que irá tornar nossos comentários em documentação propriamente dita.
Quando documentamos partes internas do nosso programa, temos que, ao mesmo tempos em que documentamos o que estamos fazendo, também geramos documentação que será posteriormente extraída nosso código e será então, gerada a documentação propriamente dita. Dessa forma, não temos o problema de ter num diretório onde há arquivos que documentam classes e funções, e noutro diretório, as classes e funções documentadas.
Assim, tudo estará junto num mesmo arquivo, feito num mesmo editor! Essa forma de trabalhar, faz com que a documentação sempre esteja atualizada e acelera o desenvolvimento de maneira geral. Até porque, no mesmo momento em que alteramos o código fonte, já podemos alterar a documentação.
É recomendável nos acostumarmos a documentar nosso código. Isso não somente faz de nós melhores programadores como também, ajuda-nos na definir qual a razão que determinado trecho de código está se propondo a realizar.
EXEMPLO FEITO EM AULA
A seguir, temos o exemplo feito durante aula sobre a utilização de comentários.
#coding: utf-8
print("Aprendendo como utilizar comentários.")
print("segunda linha")
print("terceira linha")#aqui é um comentário que não será interpretado
LINKS EXTERNOS
Tags curso, python, comentários, blog
Comentários
comments powered by Disqus