Introdução aos Comentários em Python
É essencial entender o fluxo da programação, o que se está codificando e para que serve. Geralmente, para fazer isso, um programador usa comentários para mostrar para que serve esse trecho de código, para qual método é usado a codificação / a lógica por trás dele. Esses comentários não influenciarão o código, mas fornecerão um layout para o que está sendo feito. Escrever comentários no código ajuda a melhorar o código, pois, na otimização, um programador verifica o que precisava ser aprimorado e, se os comentários mostrarem o método usado, será fácil otimizar o programa. Os comentários no Python também permitem que os outros desenvolvedores conheçam e entendam o programa. Recomenda-se usar um número suficiente de comentários para que o código não seja confuso quando olhou para trás.
Tipos de sintaxe em Python
No Python, existem dois tipos de sintaxe que são usados para comentários:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
Em todas as linguagens de programação, alguma sintaxe foi definida para identificar o que é o quê. Um programa é definido com várias sintaxes, por exemplo, fechando uma linha em c, usamos ponto e vírgula ';', Para definir o início de uma classe ou loop, usamos dois pontos ':'. Como pode ser visto, temos uma sintaxe diferente, que é a parte do código e a afeta. Deve haver alguma sintaxe que poderia dizer mais complacente para deixar parte comentada e ir para a próxima etapa, pois os comentários não têm nada a ver com a saída. Portanto, é realmente muito necessário distinguir os comentários do código real para que não seja confundido com o programa atual.
Criando comentários no Python
Um programador deve adicionar um comentário em seu programa para torná-lo mais compreensível. Agora, onde adicionar comentários? É uma escolha individual, mas aqui estão alguns lugares comuns em que a adição de comentários torna o programa mais legível.
- Início do Programa
- Ao definir parâmetros
- Definindo uma classe
- Definindo Métodos
- Lógica para os métodos / funções
- Descrição Sobre o procedimento
- Para verificar a saída de um pedaço de código
Os seguintes pontos foram explicados abaixo:
1. Início do programa
Aqui, um programador define qual é a declaração do problema e qual é a necessidade do programa.
2. Ao definir parâmetros
Aqui, um programador pode adicionar comentários para cada parâmetro, o que ele representa, como ele ajudará no programa.
3. Definindo uma classe
Um programa pode conter nulo / uma ou mais classes, portanto, é essencial definir o objetivo da classe no início dos comentários. Às vezes, é recomendável adicionar comentários entre as classes para definir o trabalho de cada linha na classe.
4. Definindo Métodos
Métodos são funções que criam relações entre parâmetros e lógica para manipulá-lo. É recomendável definir o trabalho do método nos comentários.
5. A lógica para os métodos / funções
Em geral, um método pode ter várias lógicas anexadas a ele, comentar a descrição de cada lógica pode ajudar a entender a lógica existente e, se necessário, pode ser modificado conforme o requisito.
6. Descrição do procedimento
Para cada programa, um programador segue um procedimento passo a passo e definir as etapas do procedimento / arquitetura do código nos comentários pode ajudar a melhorar sua legibilidade.
7. Para verificar a saída de um pedaço de código
Em vários casos, um programador precisaria fazer alterações no programa existente. Se um programa tiver várias lógicas e verificar se todas estão funcionando bem ou não, ele deverá ter saída de referência / saída esperada. Comentar as saídas dessa lógica logo após a lógica pode economizar muito tempo.
Exemplos de comentários em Python
Os exemplos são dados abaixo:
Os comentários não têm nenhum efeito sobre o resultado, mas tornam o programa mais legível. Aqui estão alguns exemplos de comentários em python.
1. Comentando uma linha de cada vez: Aqui estamos executando operações de adição em duas variáveis.
# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Saída: 22
2. Comentando várias linhas por vez: Às vezes, é necessário fornecer uma descrição de alguma lógica, para a qual é necessário comentar várias linhas por vez. Comentar uma única linha, repetidamente, pode ser um trabalho cansativo, por isso usamos aspas triplas para isso.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)
Saída: 22
3. Comentando uma linha e várias linhas ao mesmo tempo: Na maioria dos casos, um programador usa os dois tipos de comentários para tornar o programa mais legível.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Saída: 22
Aqui vimos alguns casos de comentários, que são usados em um programa. No caso do aprendizado de máquina, existem diferentes tipos de modelos, que são usados para prever a saída. É necessário modelar parâmetros, hiperparâmetros e procedimentos usados no algoritmo. Comentar sobre diferentes abordagens para o modelo com parâmetros diferentes pode economizar repetibilidade e economizar tempo.
Conclusão - Comentários em Python
Os comentários em um programa são muito úteis para entendê-los. Em python, basicamente temos dois tipos de comentários para comentar uma linha com sintaxe (#) ou para comentar várias linhas que usamos aspas triplas (“). Os comentários não existem para influenciar o código, mas apenas para adicionar uma descrição do que está sendo codificado lá e os Comentários não fazem parte da saída.
Artigos recomendados
Este é um guia para comentários em Python. Aqui discutimos a introdução, a criação de comentários no Python levou em consideração exemplos e sintaxe, etc. Você também pode consultar nossos outros artigos sugeridos para saber mais -
- Trocando em Python
- Comandos Python
- Engenharia reversa com Python
- Troca em C
- Variáveis em JavaScript
- Engenharia reversa | Usos | Problemas éticos
- Como Comentários funcionam em PHP? | Exemplos