Parametri

Il tab PARAMETRI ci consente di specificare in dettaglio, oltre a quanto già descritto testualmente nel tab DOCUMENTAZIONE, variabili e valori di una classe, un metodo, una procedura argomento della nostra voce di documentazione.

L’output di ciò che inseriamo come parametro verrà presentato in forma tabellare come ad esempio nella nostra Widgetpedia:

../_images/widgetpedia-textbox.png

Anche i parametri funzionano con logica gerarchica. Se quindi inseriamo dei parametri su una voce «genitore», questi verranno automaticamente ereditati e mostrati in tabella anche nella voce «figlio». Questo aspetto è particolarmente utile al fine di evitare la ripetizione manuale di tutti i parametri tra molteplici voci. Richiede tuttavia maggior attenzione nella strutturazione delle voci, in quanto dobbiamo ovviamente inserire nella voce «genitore» solo quei parametri che effettivamente sono validi anche per le voci «figlie».

Per inserire un parametro clicchiamo sul + e completiamo la scheda con questi dati:

../_images/parametri-inserimento.png
  • codice è il nome del parametro che comparirà come «Parameter name» nella tabella
  • tipo è il tipo di parametro, a scelta tra numerico, testuale, data, ecc.
  • Page permette di inserire all’interno della tabella una sottocategoria di parametro, utile per separare i parametri «veri» della voce da quelli ereditati dai genitori.
  • Doc è la descrizione che comparirà nell’ultima colonna

Autore della sezione: Davide Paci