Inserire un riepilogo delle funzioni all’intellisense di AL language
Salve lettore, in questo articolo voglio spiegarti come poter inserire una breve descrizione di riepilogo di una funzione scritta in AL language e visualizzarla nell’intellisense.
Da quando esiste la possibilità di fare overload delle funzioni in AL language, sarebbe buona norma inserire una breve descrizione delle varie funzioni. Questa pratica facilita sicuramente i colleghi che vogliono riutilizzare quella funzione, per comprenderne in maniera immediata come utilizzarla.
Abbiamo a disposizione uno snippet a corredo di AL language che ci permette di inserire automaticamente la sintassi corretta per impostare una descrizione alla funzione.
Digitando quindi ‘///’ otteniamo lo snippet dell’immagine sopra. Premendo poi tab, abbiamo la porzione di codice che serve per gestire la descrizione della funzione. Come noterai nell’imagine sotto, nei tag summary inseriremo la descrizione della funzione; nel tag param automaticamente lo snippet mette i parametri della funzione che abbiamo inserito; nel tag returns, se ci fosse stato, il nome e il tipo del parametro di ritorno.
Il risultato che otteniamo è quello che vedi nell’immagine sotto. Facile, no?
Inserire una descrizione della funzione in un overload di funzione è molto utile per chi deve utilizzare la funzione nelle sue diverse declinazioni. Tuttavia è anche possibile inserire una descrizione a una funzione che non è in overload, l’intellisense mostrerà anche di essa la descrizione.
Hai già utilizzato l’overload delle funzioni e hai già documentato in questa maniera le funzioni fatte?
