Commenti ruggine

I commenti sono una funzionalità incredibilmente utile che consente agli sviluppatori di includere la documentazione breve ma descrittiva in un programma.

La possibilità di aggiungere commenti al tuo codice può aiutare a migliorare la leggibilità per te e altri sviluppatori che potrebbero leggere e utilizzare il tuo codice.

Come funzionano i commenti?

I commenti non sono niente di speciale. Sono solo un insieme di caratteri di testo che descrivono come o cosa sta facendo un pezzo di codice.

Il commento utilizza caratteri speciali che fanno ignorare il compilatore. Discutiamo di come possiamo implementare e utilizzare i commenti nei nostri programmi.

Commenti ruggine

Esistono tre tipi di commenti in ruggine:

1. Commenti semplici o di linea
2. Blocca commenti
3. Commenti Doc

Discutiamo.

Semplici commenti di linea

I commenti semplici o di linea sono il tipo di commenti che si estendono una singola riga. Sono usati principalmente per inserire un messaggio breve e descrittivo in un blocco di codice.

In Rust, possiamo inserire commenti a linea singola usando i caratteri a doppia cassa in avanti. Un esempio è come mostrato:

fn main ()
// Commento a riga singola
println!("Ciao mondo!");

Come accennato, un commento a linea singola si estende a una riga singola. Come mostrato nell'esempio, il compilatore a coperto ignora la riga dopo 8 i due caratteri in avanti slash.

Blocca commenti

Il secondo tipo di commento è noto come commenti di blocco. Questi sono strettamente simili a semplici

Sttart aprendo il blocco dei commenti con un carattere di slash in avanti e un asterisco, come (/*).

Successivamente, possiamo aggiungere il testo dei commenti e chiudere il blocco dei commenti con un asterisco e un contraccolpo come (*/).

Un esempio di commento a blocchi in ruggine è come mostrato:

fn main ()
/*
Un commento a blocchi
campate
linee mutliple
*/
println!("Ciao mondo!");

Il codice sopra mostra la creazione di un commento a blocchi che si estende per più righe.

Commenti Doc

Rust ci fornisce anche commenti Doc. Esistono due tipi principali di commenti DOC in Rust:

1. Commenti interni del doc
2. Commenti del documento esterno.

Commenti interni del doc

I commenti del documento interno sono indicati da una doppia barra e un botto come //!. Sono scritti all'interno di un blocco di codice vengono utilizzati principalmente per generare documentazione per un codice all'interno di un blocco specificato.

Un esempio è come mostrato:

fn main ()
//! Documentazione
println!("Ciao mondo!");

Il codice sopra indica un commento del documento interiore.

Commento del documento esterno

Come suggerisce il nome, un commento del documento esterno si riferisce a un commento che circonda un blocco esterno di codice e funge da documentazione per quel blocco.

I commenti del documento esterno sono indicati da tagli tripli in avanti. Un esempio è mostrato:

/// funzione principale
///
fn main ()
println!("Ciao mondo!");

Conclusione

Questo articolo ti aiuta a comprendere vari tipi di commenti in ruggine e come creare messaggi brevi e descrittivi per i blocchi di codice.

Speriamo che ti sia piaciuto l'articolo, grazie!