Comentaris en Python són les línies del codi que l'intèrpret ignora durant l'execució del programa.

>

estructura en l'estructura de dades

>

Els comentaris milloren la llegibilitat del codi i ajuden els programadors a entendre el codi amb molta cura. També ajuda a col·laborar amb altres desenvolupadors, ja que afegir comentaris facilita l'explicació del codi.

Tipus de comentaris en Python

Hi ha tres tipus de comentaris a Python:

• Comentaris d'una sola línia
• Comentaris multilínia
• Literals de cadena
• Comentaris de Docstring

Comentaris en Python

En l'exemple, es pot veure que Python L'intèrpret ignora els comentaris durant l'execució del programa.

Python 3

>

per què la cadena és immutable a Java

>

Sortida:

geeksforgeeks>

Per què s'utilitzen els comentaris a Python?

Els comentaris han estat una part integral dels llenguatges de programació i cada llenguatge té maneres diferents d'utilitzar els comentaris.

Igual que qualsevol altre llenguatge, els comentaris a Python tenen el propòsit següent:

1. Millora la llegibilitat del codi
2. Explicar el codi als altres
3. Comprensió del codi si s'estudia després d'un temps
4. Documentació dels passos i necessitats d'una funció
5. Compartint codi amb altres desenvolupadors
6. Col·laboració amb diverses persones.

Tipus de comentaris en Python

Descobrim els diferents tipus de comentaris, com utilitzar-los i quan fer-los servir?

1. Línia única Comentaris

• El comentari d'una sola línia de Python comença amb el símbol de l'etiqueta (#) sense espais en blanc i dura fins al final de la línia.
• Si el comentari supera una línia, poseu un hashtag a la línia següent i continueu amb el comentari de Python.
• Els comentaris d'una sola línia de Python s'han demostrat útils per proporcionar explicacions breus per a variables, declaracions de funcions i expressions. Vegeu el fragment de codi següent que mostra el comentari d'una sola línia:

Exemple:

Python 3

>

>

inseriu una marca d'aigua a Word

techcodeview.com>

2. Comentaris de diverses línies

Python no ofereix l'opció comentaris multilínia . Tanmateix, hi ha diferents maneres a través de les quals podem escriure comentaris multilínia.

a) Comentaris de diverses línies amb diversos hashtags (#)

Podem múltiples hashtags (#) per escriure comentaris multilínia en Python. Cada línia es considerarà com un comentari d'una sola línia.

Python 3

>

>

Multiline comments>

Comproveu també: Fet interessant sobre els comentaris multilínia de Python

3. Literals de corda

Python ignora el literals de cadena que no estan assignats a una variable, de manera que podem utilitzar aquests literals de cadena com a comentaris de Python .

a) Comentaris d'una sola línia utilitzant literals de cadena

En executar el codi anterior podem veure que no hi haurà cap sortida, així que fem servir les cadenes amb cometes triples () com a comentaris de diverses línies.

Python 3

>

>

b) Comentaris multilínia utilitzant literals de cadena

Python 3

bash si més

>

>

Multiline comments>

4. Docstring

• Cadena de documents Python són els literals de cadena amb cometes triples que apareixen just després de la funció.
• S'utilitza per associar documentació que s'ha escrit amb mòduls, funcions, classes i mètodes de Python.
• S'afegeix just a sota de les funcions, mòduls o classes per descriure el que fan. A Python, la docstring es posa a disposició mitjançant l'atribut __doc__.

Exemple:

Python 3

>

canviar el nom de la carpeta a linux

>

Sortida:

Multiplies the value of a and b>

Avantatges dels comentaris en Python

Els comentaris s'utilitzen generalment amb els propòsits següents:

• Llegibilitat del codi
• Explicació del codi o Metadades del projecte
• Impedir l'execució del codi
• Per incloure recursos

Manera correcta d'escriure comentaris

Els comentaris serveixen per explicar el vostre codi. Els desenvolupadors utilitzen pràctiques saludables d'escriptura de comentaris per entendre millor el codi.

Alguns dels consells que podeu seguir per fer efectius els vostres comentaris són:

1. Els comentaris han de ser breus i precisos.
2. Utilitzeu els comentaris només quan sigui necessari, no desordenau el vostre codi amb comentaris.
3. El comentari hauria de tenir algun significat.
4. Eviteu escriure comentaris genèrics o bàsics.
5. Escriu comentaris que s'explicaran per si mateixos.

Hem parlat sobre els comentaris de Python, com escriure comentaris de Python, els tipus de comentaris, quins són els seus avantatges i la manera correcta d'escriure comentaris.

Llegeix també: Com escriure comentaris a Python3?