Commenti

Ci sono due modi per commentare un algoritmo Black3

1. Commento in linea
2. Commento multilinea

Esempio 1

$b3[1][OBJ]{         
   // questo è un commento in linea         
   ...  
}  

$b3[2][OBJ]{         
   /* questo è un commento multilinea 
   perchè posso scriverlo 
   su più linee */         
...  }

Best Practice

I commenti sono utili per annotazioni veloci su modifiche da effettuare all’algoritmo Black3 e per descrivere in modo specifico le operazioni da effettuare con i comandi.

I commenti non possono avere carattere algoritmico. Ne consegue che un commento non può essere soggetto all’esecuzione di alcun comando all’interno dell’algoritmo.

Non è quindi possibile utilizzare i commenti con la stessa logica di un comando.

Nel caso in cui un commento serva per dichiarare l’intenzione di apportare modifiche, a modifiche effettuate il commento dovrebbe essere immediatamente rimosso o modificato secondo esigenza. Questo per evitare confusione o errori interpretativi dell’algoritmo, soprattutto in un ambiente che sfrutta diverse recipe.

Nel caso in cui sia necessario inserire nel workflow un commento di natura algoritmica si deve utilizzare il comando NOTE.

NB: questo aspetto va tenuto in debita considerazione soprattutto dal punto di vista delle recipe scambiate tra due o più sviluppatori Black3 (multiutenza).

L’algoritmo ha validità solamente nell’ambito dell’esecuzione dei comandi.

Assegnare quindi un comando o segnalarlo ad un altro programmatore tramite recipe usando un commento non può essere considerata un’operazione algoritmica.

I commenti servono agli sviluppatori esclusivamente per ragionare sul codice, per spiegare alcuni passaggi, per suggerire modifiche ecc.