Commenti in Python - Creazione dei commenti in Python

Sommario:

Anonim

Introduzione ai commenti in Python

È essenziale comprendere il flusso della programmazione, a cosa serve la programmazione e a cosa serve. In genere, per fare ciò un programmatore utilizza i commenti per mostrare a cosa serve quel pezzo di codice, a quale metodo viene utilizzato per la codifica / la logica che sta dietro. Questi commenti non influenzeranno il codice, ma forniranno un layout per ciò che viene fatto. Scrivere commenti nel codice aiuta a migliorare il codice poiché nell'ottimizzazione un programmatore controlla ciò che deve essere migliorato e se i commenti mostrano il metodo utilizzato sarà facile ottimizzare il programma. I commenti in Python consentono inoltre agli altri sviluppatori di conoscere e comprendere il programma. Si consiglia di utilizzare un numero sufficiente di commenti in modo che il codice non crei confusione quando guardava indietro.

Tipi di sintassi in Python

In Python ci sono due tipi di sintassi utilizzati per i commenti:

#: Is used to comment on one line.

Triple quotes (“): To comment more than one line.

In tutti i linguaggi di programmazione, è stata definita una sintassi per identificare ciò che è cosa. Un programma è definito con un numero di sintassi per esempio, chiudendo una riga in c usiamo un punto e virgola ';', Per definire l'inizio di una classe o di un ciclo usiamo i due punti ':'. Come si può vedere, abbiamo una sintassi diversa che è la parte del codice e la influenza. Dovrebbe esserci una sintassi che potrebbe dire complier per lasciare la parte commentata e andare al passo successivo, poiché i commenti non hanno nulla a che fare con l'output. Quindi, è davvero molto necessario distinguere i commenti dal codice effettivo in modo da non confonderlo con il programma reale.

Creazione di commenti in Python

Un programmatore deve aggiungere un commento nel suo programma per renderlo più comprensibile. Ora dove aggiungere commenti? È una scelta di un individuo, ma qui ci sono alcuni luoghi comuni in cui l'aggiunta di commenti rende un programma più leggibile.

  1. Inizio del programma
  2. Quando si definiscono i parametri
  3. Definire una classe
  4. Definizione dei metodi
  5. Logica per i metodi / funzioni
  6. Descrizione Informazioni sulla procedura
  7. Per controllare l'output di un pezzo di codice

Di seguito sono stati spiegati i seguenti punti:

1. Avvio del programma

Qui un programmatore definisce qual è la dichiarazione del problema e qual è la necessità del programma.

2. Quando si definiscono i parametri

Qui un programmatore può aggiungere commenti per ogni parametro che cosa rappresenta, come aiuterà nel programma.

3. Definizione di una classe

Un programma può contenere null / una o più classi, quindi è essenziale definire lo scopo della classe all'inizio dei commenti. A volte si consiglia di aggiungere commenti tra le classi per definire il lavoro di ciascuna riga della classe.

4. Definizione dei metodi

I metodi sono funzioni che creano relazioni tra parametri e logica per manipolarlo. Si consiglia di definire il lavoro del metodo nei commenti.

5. La logica per i metodi / funzioni

In generale, un metodo può avere un numero di logiche associate ad esso, commentare la descrizione di ogni logica può aiutare a comprendere la logica esistente e, se necessario, può essere modificato secondo il requisito.

6. Descrizione della procedura

Per ciascun programma, un programmatore segue una procedura dettagliata e la definizione dei passaggi della procedura / architettura del codice nei commenti potrebbe contribuire a migliorarne la leggibilità.

7. Controllo incrociato dell'output di un pezzo di codice

In alcuni casi, un programmatore dovrebbe apportare modifiche al programma esistente. Se un programma ha una serie di logiche e per verificare se tutti funzionano correttamente o no, dovrebbe avere un output di riferimento / output previsto. Commentare le uscite di quella logica subito dopo la logica potrebbe far risparmiare molto tempo.

Esempi di commenti in Python

Gli esempi sono riportati di seguito:

I commenti non hanno alcun effetto sull'output che mai, ma rendono un programma più leggibile. Ecco alcuni esempi di commenti in Python.

1. Commentando una riga alla volta: qui stiamo eseguendo un'operazione di addizione su due variabili.

# 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

Uscita: 22

2. Commentare più righe alla volta: a volte è necessario fornire una descrizione di alcune logiche, per le quali è necessario commentare più righe alla volta. Commentare una sola riga, ancora e ancora, potrebbe essere un lavoro stancante, quindi per questo usiamo le virgolette triple.

"""
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)

Uscita: 22

3. Commentare una riga o più righe contemporaneamente: nella maggior parte dei casi, un programmatore utilizza entrambi i tipi di commenti per rendere il programma più leggibile.

"""
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

Uscita: 22

Qui abbiamo visto alcuni casi di commenti, che sono utilizzati in un programma. Nel caso dell'apprendimento automatico, esistono diversi tipi di modelli che vengono utilizzati per prevedere l'output. È necessario modellare parametri, iperparametri e procedura utilizzati nell'algoritmo. Commentare approcci diversi per il modello con parametri diversi può salvare la ripetibilità e può risparmiare tempo.

Conclusione - Commenti in Python

I commenti in un programma sono molto utili per capirli. In Python, abbiamo fondamentalmente due tipi di commenti per commentare una riga con sintassi (#) o per commentare più righe che utilizziamo le virgolette triple (“). I commenti non sono lì per influenzare il codice ma solo per aggiungere una descrizione di ciò che viene codificato lì e i commenti non farebbero parte dell'output.

Articoli consigliati

Questa è una guida ai commenti in Python. Qui discutiamo l'introduzione, la creazione di commenti in Python che hanno preso in considerazione, esempi e sintassi, ecc. Puoi anche consultare i nostri altri articoli suggeriti per saperne di più -

  1. Scambiare in Python
  2. Comandi Python
  3. Ingegneria inversa con Python
  4. Scambiare in C
  5. Variabili in JavaScript
  6. Ingegneria inversa | Usi | Problemi etici
  7. Come funzionano i commenti in PHP? | Esempi