Documentare il proprio codice: una buona abitudine
Uno degli aspetti che personalmente tendo a curare nella scrittura del codice è la sua documentazione. Non mi riferisco (solo) all’inserimento dei classici commenti utili per ricordare cosa fa una particolare riga di codice, ma alla stesura di quelle istruzioni per l’uso complete che vengono associate ai tipi di dati in generale, ai metodi e ai loro parametri, ai valori di ritorno, alle proprietà, ai campi e così via. Ritengo si tratti di un’attività fondamentale, soprattutto quando si lavora in team, affinché diversi sviluppatori possano conoscere immediatamente quali sono le funzionalità di una determinata classe, o qual è lo scopo di un metodo e dei parametri da specificare, senza dover perdere tempo ad analizzare il codice implementativo, ammesso che questo
Leggi l'articolo completo
Commenti recenti