Condividere.

In fase di progettazione, una delle parti più complesse, è sicuramente la condivisione delle informazioni.

E' possibile che membri dello stesso gruppo possano trovarsi nella spiacevole circostanza di avere informazioni diverse, sullo svolgimento del progetto.

E' sufficiente un piccolo problema a creare problemi relativamente grossi.

La base di questo rischio è la scarsità o l'inapropriata condivisione delle informazioni.

La Ide del frame work mette a disposizione svariate possibilità per realizzare frammenti di documentazione, e meglio ancora dispone di un tool dedicato completamente al diagramma delle classi.

/// <>
///
/// < /summary >
/// < name="obj"> < /param >

Questo tag si può (si deve/si dovrebbe) utilizzare, per dare una completa panoramica di quello quanto svolge il metodo.
Può essere esteso anche alle proprietà o agli eventi.

Ma ancora una volta è necessario che sia utilizzato con buon senso e cognizione di causa.


/// <>
/// Metodo WriteToPort Scarica il buffer sulla porta indicata dal parametro port
///< /summary >
///
/// < name="Port">Indirizzo logico della porta su cui scrivere< /param >


Questo "commento" risulta Leggibile e quanto meno comprensibile chiunque riesce a comprendere qual'e' lo scopo del metodo che sta per leggere.

Non da meno nel caso di utilizzo della class che espone questo metodo si avrebbe un tooltip recante la medesima descirzione.


/// <>
/// WriteToPort
/// Scrive dei bit nella port ( quando funziona !! )
/// < /summary >
/// < name="Port">< /param >


Naturalmente questo commento non è assolutamente valido, ne comprensibile. Ma il più delle volte ringrazio anche chi scrive commenti simili, perchè quanto meno ci sono.

E' valutabile il fatto che un commento sia efficace o meno, si deve comunque sensibilizzare il proprio team a creare
commenti OGGETTIVAMENTE comprensibili.

Un ulteriore strumento è la direttiva #region che permette di raggrupare delle righe di codice secondo una determinata logica.

#region Private
private int _id_CampoChiave;
private string _Campo_Nome;
private string _Campo_Note;
#endregion

In questo specifico caso è possibile indicare la presenza di una serie di attributi privati.

E' possibile specificare definizioni più o meno complesse, o annidare vari region fra loro.

Ancora una volta è necessario istruire il proprio gruppo in modo che vi sia uno standard diffuso e conosciuto, al fine
che tutti possano CONDIVIDERE la stessa esperienza.