Comentários de Python

Introdução

Este guia não é sobre programação. De fato, não há novo código envolvido. No entanto, tem tudo a ver com garantir que o código que você escreve seja compreensível para você e para qualquer outra pessoa que possa olhar para isso na linha.

Se você analisou algum projeto de código aberto, provavelmente notou anotações colocadas pelos programadores. Essas notas são apenas texto simples. A linguagem de programação não os compila ou interpreta de forma alguma. Apenas os ignora. Ele sabe que esses comentários são para humanos, não computadores.

Os comentários são muito importantes. Mesmo se você não estiver compartilhando seu código com mais ninguém, você encontrará um exemplo em que olhará para trás para algo que escreveu há muito tempo e se perguntará: “O que eu fiz aqui?"Se você está interessado em trabalhar em um projeto de código aberto, o que é, é provável que você esteja, já que está lendo isso em um site Linux, comentar é ainda mais importante. A última coisa que você deseja é que seu compromisso seja rejeitado porque não é comentado e o mantenedor não quer perder tempo para descobrir o que faz. Comentários também são importantes no script do sistema. Há muito poucos departamentos de TI para uma pessoa única por aí, e seus colegas de trabalho não serão felizes se não souberem o que está acontecendo em seus scripts.

Comentando em Python

Como muitos outros idiomas, o Python tem dois tipos diferentes de comentários, uma linha única e multi -. Os comentários de linha única são excelentes para adicionar um comentário rápido antes de um bloco de código ou logo após uma linha de código explicando o que faz. Comentários de várias linhas são úteis para adicionar um cabeçalho ou uma descrição mais detalhada a um pedaço de código. Eles também são ótimos para comentar um bloco de código para que ele não seja executado, o que é ótimo para depuração.

Comentários de linha única

Em Python, um comentário de linha única começa com um #. Este é um símbolo bastante comum para usar em linguagens de script. Aqui está um exemplo de como você usaria um comentário de linha única como uma descrição.

a = 10 b = 15 a = b # Defina a Igual a b imprimir (a + b) 

O código será executado exatamente como faria se o comentário não estivesse lá. O comentário está lá apenas para você.

Você também pode usar um comentário de linha única para dizer o que as próximas linhas de código farão.

# Importar a biblioteca de matemática Importar matemática # Run o teorema de Pitágoras A = 3 B = 4 C = Matemática.sqrt (a ** 2 + b ** 2) 

Mesmo que seja um exemplo simples de que você provavelmente possa descobrir o jut olhando para ele, os comentários tornam a olhada muito mais rápida. Imagine o tempo que seria salvo em um projeto mais complexo.

Agora, dê uma olhada em como você pode usar um comentário de linha única para impedir que uma linha de código seja executada.

a = 10 b = 15 # a = b o que acontece se a não for definido igual à impressão b (a + b) 

A linha que se fixou a igual a b não funcionou, dando um resultado diferente do exemplo anterior

Comentários de várias linhas

Em Python, você pode denotar um comentário de várias linhas usando "" " antes e depois do código que você deseja comentar. Obviamente, você também pode usar isso para comentários de texto mais longos, como informações do cabeçalho.

"" "Python Test Author = seu nome último atualizado = 1 de novembro de 2016 Versão Python - 3.4.3 Número da versão = 1.0.0 "" " 

Nada disso significa nada para um computador, mas é excelente para documentar o progresso de um projeto. Manter as informações como essa nos arquivos do projeto não afetam o programa real, mas permite que você e qualquer outra pessoa que trabalhem no projeto tenham acesso rápido e fácil a informações vitais. Isso é ótimo para documentar projetos colaborativos com vários arquivos e vários autores. Lembre-se de que a maioria dos projetos do mundo real será complexa; portanto, documentar seu código dessa maneira é um bom hábito de entrar.

Comentários de várias linhas também são essenciais para a depuração. Digamos que você acabou de implementar um novo recurso para o seu projeto, mas esse novo código está causando um erro. Você pode comentar seções inteiras para testar a peça de funcionalidade do novo recurso, por peça, até finalmente descobrir onde o problema está. Digamos que o exemplo "teorema pitagórico" de cima foi parte de um recurso que estava falhando. Você pode fazer algo como o código abaixo.

# Importar a biblioteca de matemática Importar matemática "" "Falha - por favor, depure # execute o teorema de Pitagoreano a = 3 b = 4 c = sqrt (a ** 2 + b ** 2)" "" 

Você também pode usar comentários de várias linhas para interromper um código antigo enquanto o substitui. Apenas excluir o código geralmente não é a melhor prática. Afinal, depois de excluí -lo, ele se foi. Comentando que o código impede que ele funcione, mas também o preserva como uma referência ou de volta, caso você precise olhar novamente.

Conclusão

Comentar o código é importante. Que não pode ser exagerado. Pode parecer tedioso e chato. Ele não tem o flash de escrever uma nova linha assassina que implementa um recurso, mas a longo prazo, você ficará feliz que esses comentários estejam lá. Os comentários também são uma ferramenta de depuração inestimável que pode fornecer um procedimento sólido para testar um pedaço de código falhado. Continue praticando usando comentários e vendo como eles podem impactar o fluxo de código ao eliminar linhas ou blocos de código.

Índice

1. Guia de Introdução e Introdução ao Python
2. Arquivos python e o intérprete
3. Experimentando números e texto em python
4. Variáveis ​​Python
5. Trabalhando com variáveis ​​numéricas em Python
6. Python String Basics
7. Strings avançados de Python
8. Comentários de Python
9. Listas de Python
10. Métodos de lista de Python
11. Listas multidimensionais do Python
12. Tuplas de Python
13. Operadores booleanos em Python
14. Python IF Declarações
15. Python enquanto loops
16. Python para loops
17. Dicionários de Python
18. Dicionários avançados de Python
19. Funções python

Tutoriais do Linux relacionados:

• Expressões regulares do Python com exemplos
• Instale Arch Linux na estação de trabalho VMware
• Como trabalhar com a API de Rest WooCommerce com Python
• Como construir um aplicativo Tknter usando um objeto orientado…
• Como gerenciar repositórios Git com Python
• Tutorial de depuração do GDB para iniciantes
• Bash Regex avançado com exemplos
• Coisas para instalar no Ubuntu 20.04
• Bash Loops com exemplos
• Sistema Linux Hung? Como escapar para a linha de comando e…