Linee guida nella scrittura di codice #14: Gli attributi

Come sappiamo gli attributi utilizzati in .NET sono una componente importante di un progetto e se ben utilizzati possono essere di grande aiuto. Pensiamo ad esempio alla possibilità  di creare attributi custom attraverso i quali, ad esempio, decorare tutte le classi della nostra applicazione per associare ad esse una descrizione da poter poi includere nella nostra documentazione inline. Nella creazione di attributi custom è opportuno seguire alcune semplici indicazioni.

Apporre sempre il suffisso Attribute a tutte le nostre classi che ereditano dalla classe base Attribute. Ad esempio:

public class HelpAttribute : Attribute {}

Sulle nostre classi attributo personalizzate specifichiamo l'attributo AttributeUsage per definire meglio e più precisamente l'ambito di utilizzo dell'attributo:

[AttributeUsage(AttributeTargets.All, Inherited = false, AllowMultiple = true)]
public class HelpAttribute: Attribute {}

Rendere sealed le nostre classi Attribute per evitare che da esse si possano derivare altre classi.

Utilizzare i parametri del costruttore per i parametri obbligatori. Creare inoltre per ogni parametro del costruttore (obbligatori) anche una proprietà  di sola lettura che abbia lo stesso nome ma che differisca nell'uso delle maiuscole/minuscole.

Per i parametri facoltativi usare invece proprietà  di lettura/scrittura.