Como escrever comentários em seus arquivos de código python

Video: Como marcar todos seus amigos em uma publicação no Facebook 2017

Escrever comentários em seus arquivos de código Python é uma coisa boa porque você pode se comunicar mensagens para o seu próprio futuro no texto do programa. Vamos dar uma olhada em um arquivo de exemplo de código.

""Este é apenas um arquivo de teste""print ( `Olá Mundo! a partir do editor`) 

A primeira linha aqui é chamado de comente. Parece que strings literais, porque isso é o que é. Quando Python vê uma string literal em um arquivo ignora-lo! Neste caso, você está dizendo a si mesmo que este arquivo é apenas um arquivo de teste, para que você não deve ser muito chateado se você mexer-se.

Video: Emoticons nos comentários do Facebook veja como fazer

Você tem um monte de boas razões para escrever comentários em seu código:

• 
  
  
  

  Como uma explicação. Sempre que você criar um novo arquivo Python, escrever uma breve explicação sobre o que o código é suposto fazer. Não repetir o que o código está fazendo. Resumir o que o código é para. O que você quer alcançar? Assim, no código a = a + 1 # 1 adicionando a um o comentário é inútil, porque qualquer idiota pode ver que o código está adicionando 1 a um. Você geralmente não iria incluir um comentário aqui a menos que houvesse uma razão que não é clara a partir do código. Por exemplo: a = a + 1 # A alteração de um faz com que os dados a ser actualizada no bloco de código próximo.

• Como um auxiliar de memória. Quando você é primeiro escrever seu código estiver muito próximo a ele. Você está familiarizado com ele. Você entende por que você colocar o que você colocar onde e porquê. Como o tempo passa, você vai esquecer por que você colocar esse pedaço de código em algum lugar. É muito mais fácil de ler uma descrição do que trabalhar com isso mais tarde.

• Como um meio de comunicação. Quando você dá o seu código para alguém, uma explicação Inglês de que o código faz é ainda mais importante. Comentários permitem que você colaborar (Trabalhar em conjunto) melhor com os outros. Se você quer trabalhar como parte de uma equipe de programação, é melhor você ter bons comentários em seu código.

• Como uma ajuda de depuração. Se há um problema com o seu código, alguém terá de entrar e corrigi-lo, e pode não ser você. Mais uma vez, ter uma explicação Inglês sobre o que está acontecendo é uma grande ajuda.

• Porque é bom para você. Como legumes, apenas a mais saborosa.

  Video: Criando comentários e marcando texto no Adobe Reader