I commenti sono essenziali nella vita di uno sviluppatore. Quando lavoriamo a una nuova funzionalità, spesso aggiungiamo commenti che sono dei promemoria. Ad esempio:
- per convalidare una parte di codice con un collega,
- per rifattorizzare una funzione,
- per correggere il codice che rallenta le prestazioni,
- per dividere un metodo o una classe in sezioni,
- preparare lo scheletro di una classe e aggiungere un commento all’interno di ogni funzione.
Anche se scrivete del codice semplice, provate a leggerlo mesi o anni dopo. Vi sembrerà ancora semplice o vorreste aver aggiunto dei commenti?
4D v19 R4 porta i commenti a un livello completamente nuovo, grazie ai tag di commento che consentono di organizzare meglio i commenti.
Sono disponibili tre nuovi tag:
- MARCA
- TODO
- FISSO
In questo precedente post del blog, abbiamo mostrato un elenco nell’editor di codice, che consente di navigare facilmente all’interno della classe. Anche i commenti preceduti da questi tre tag vengono visualizzati in questo elenco.
È possibile utilizzarli all’interno delle classi o dei metodi.
Come usarli
Il tag MARK consente di suddividere il codice in sezioni. È possibile scriverlo in tre modi diversi. Gli altri due tag TODO e FIXME si scrivono nello stesso modo. Il vantaggio è che hanno icone diverse nell’elenco, il che consente di organizzare il codice per dare priorità alle azioni future.
- //MARK: il mio commento: per aggiungere una sezione
- //MARK:- il mio commento con la linea: per aggiungere una sezione con una linea di separazione
- //MARK:-: per aggiungere solo una linea di separazione
- //TODO: Per fare questo
- //FIXME: Correggere questo
Ecco un esempio con una classe ORDA:
Le funzioni e i tag di commento sono visualizzati nel loro ordine di apparizione all’interno della classe e del metodo. Se si preferisce, è possibile visualizzare le funzioni e i tag di commento di una classe in ordine alfabetico tenendo premuto Cmd su macOS o Alt su Windows prima di distribuire il menu.
Che cosa c’è dopo?
Siete pronti a migliorare il vostro gioco di codifica con questa nuova funzione? Diteci cosa ne pensate di questa nuova possibilità di organizzare il vostro codice e di navigare nelle vostre classi o metodi. Vi aspettiamo nel forum.