Commenti in Microsoft Dynamics AX

Tutto quello che c’è da sapere sui commenti di Microsoft Dynamics AX.

In questo articolo andremo a vedere quali sono le regole fondamentali per la corretta gestione dei commenti e come aggiungerli all’interno del nostro codice in Microsoft Dynamics AX.

Quando si sviluppa è buona norma commentare le varie parti del programma. Questa operazione, che potrebbe inizialmente sembrare inutile, in futuro potrebbe esserci molto utile per ricordarci il motivo per cui abbiamo scritto il codice in quella maniera. Questo accorgimento deve essere applicato anche nel caso in cui si vada ad effettuare aggiunte o modifiche all’interno del programma.

Possiamo, quindim definire le seguenti “macro” regole:

• Aggiungere sempre all’inizio del metodo il riepilogo di cosa fa il programma, cosa viene passato come parametro in ingresso e cosa eventualmente il programma restituirà come output
• Aggiungere una riga di commento prima dell’eventuale parte modificata specificando il motivo di tale modifica
• Specificare nella riga di commento la data e l’utente che ha effettuato la modifica

E’ possibile anche creare delle Macro che permettono di aggiungere commenti creati ad hoc per ogni situazione.

I commenti possono essere:

• Su una singola riga immettendo i caratteri //
• Su più righe immettendo i caratteri /* all’inizio e */ alla fine del commento

Ora vediamo qualche esempio concreto:

/* Metodo Aggiunto il 24 mag 2017 da Faion */
/*---- Descrizione Metodo ----
- Funzionalità           :
- Job che spiega il come aggiungere dei commenti
-
- Parametri di ingresso  :
-
-
- Valore di ritorno      :
-
*/
static void Commento(Args _args)
{
    //Questo è un commento su una singola riga
    
    /*
    Questo è un commento
    su più righe
    */
}

*Tale articolo può essere applicato a qualsiasi versione di Microsoft Dynamics Ax.

Ti potrebbe anche interessare:

• Come creare un commento personalizzato in Microsoft Dynamics AX