Comentários Python

Os comentários são as linhas de um programa de computador que ajudam a construir uma melhor compreensão da funcionalidade do sistema. Em qualquer linguagem de programação, os comentários são escritos em linguagem natural e de forma legível por humanos. Eles não são executados, em vez disso, são ignorados pelo compilador ou interpretador. Os comentários em Python são usados para vários fins. Neste artigo, explicaremos como você pode adicionar comentários em python.

Benefícios do uso de comentários em Python

A seguir estão os benefícios de usar comentários em Python:

Os comentários tornam o código mais legível: Ao desenvolver um programa de computador, o programador escreve várias classes e milhares de linhas de código. Às vezes, o programador esquece porque um determinado trecho de código é escrito. Os comentários tornam o código mais legível e nos ajudam a lembrar por que um trecho de código é adicionado e qual é sua finalidade.

Os comentários aumentam a compreensão do código: Os comentários nos ajudam a entender porque um determinado bloco de código é adicionado ao programa e qual é a sua finalidade. Se um programador escreve um bloco de código, então ele não pode adicionar os comentários porque ele entende o propósito de escrever um bloco específico de código. Mas, se outro programador deseja atualizar o código, então não é tão fácil para ele entender o código em minutos. Então, quando adicionamos os comentários, isso ajuda outros programadores a entender o código. Vamos supor que você esteja trabalhando no projeto Python. Era o projeto de tamanho médio inicialmente. Mas, por enquanto, sua empresa deve aprimorar este projeto e trazer mais desenvolvedores e programadores para escrever o código. Se você não escreveu os comentários em seu programa, verá que será muito difícil para eles entenderem o código e levará mais tempo. Mas se você escreveu corretamente os comentários com cada bloco de código, os desenvolvedores recém-contratados compreenderão facilmente o código existente. Inicialmente, escrever e manter os comentários leva algum tempo, mas economiza muito tempo no futuro.

Os comentários promovem a reutilização do código: Quando desenvolvemos sistemas de software semelhantes, reutilizar o existente é a melhor prática. Isso economiza muito nosso esforço e tempo. Ao reutilizar o código, primeiro verificamos quais componentes precisamos reutilizar. Temos que entender a funcionalidade de um componente específico. Os comentários nos ajudam a entender a funcionalidade do componente e promovem a reutilização do código.

Escrever comentários em Python

Escrever comentários em Python é muito fácil. Os comentários em Python começam com a marca #. Em python, usamos três tipos de comentários:

Comentários de linha única
Comentários inline
Comentários multilinhas

Comentários de linha única

Os comentários de uma linha são escritos resumidamente em uma única linha. Comentários de linha única transmitem o propósito de escrever uma função específica ou uma linha de código. Em um programa simples, o comentário é assim:

Resultado

A saída é impressa no console Python. Na saída, apenas “Hello World” é impresso. O comentário é ignorado pelo compilador.

Em um loop for, os comentários são assim

Comentários inline

Os comentários inline são escritos no final da linha de código. Em um programa simples “Hello World”, o comentário embutido é assim

O comentário inline em um loop for é assim:

Comentários multilinha

Python não fornece uma maneira distinta de escrever comentários de várias linhas. Podemos escrever comentários de várias linhas em Java, C, C ++ e C #, mas em Python, não há uma maneira separada de escrever comentários de várias linhas. Os comentários multilinhas são geralmente usados para explicar blocos complexos de código. Em comentários de várias linhas, cada linha começa com a marca #. Se quisermos escrever várias linhas de comentários, cada linha começará com uma marca # como esta:

Conclusão

Os comentários são muito úteis no programa Python. Isso nos ajuda a entender o programa. Isso torna os programas Python mais legíveis para humanos. Os comentários promovem a reutilização de programas existentes. Neste artigo, vimos três maneiras de adicionar comentários em Python. Usando essas três maneiras, você pode tornar seus programas Python mais legíveis, compreensíveis e reutilizáveis.