Il modo migliore per rendere riutilizzabile il software è renderlo visibile e comprensibile .
- Se nessuno lo sa, nessuno lo userà.
- Se nessuno riesce a capire come usarlo, nessuno lo userà.
Per gli sviluppatori questo significa fare una buona documentazione e utilizzare gli strumenti. Discuterò Java poiché è quello che conosco meglio:
Usa JavaDoc : Questo consente di creare documentazione API con riferimenti incrociati in cui lo scheletro viene creato automaticamente e di disporre di spazi ben definiti per inserire gli snippet di codice HTML nel codice che verranno quindi inclusi nella documentazione web. Consulta la documentazione ufficiale di Java per un buon esempio. Secondo me questa è una delle migliori documentazioni basate su codice oggi disponibile.
Metti JavaDoc in un posto ricercabile : affinché le persone possano trovarlo devi renderlo pubblico. Avere un server Web interno a cui indirizzare tutta la documentazione, probabilmente sottoclasse per progetto. In un mondo perfetto hai un sito web SINGLE che incorpora le classi ALL sviluppate internamente.
Semplifica l'accesso: hai un link di posizione dal quale è estremamente semplice estrarre il codice sorgente (o la libreria). Eclipse ha alcuni meccanismi per farlo. Preferibilmente la fonte da un repository di origine, dato che il repository di origine può RACCONTARE chi ha lavorato su un dato pezzo di codice, dando una buona idea di chi parlare con il caso in cui abbia bisogno di assistenza con quel codice.
Buoni esempi di utilizzo: il modo più semplice per mostrare come usarlo è con buoni test unitari, in quanto dimostrano come usare il codice e cosa aspettarsi. Essendo eseguibili possono verificare che il codice funzioni come descritto.