Ci sono alcuni progetti opensource, che hanno classi e classi senza alcuna spiegazione significativa su ciò che la classe fa e o perché è necessaria quella classe. Ad esempio, le classi nel plugin CppEditor per QtCreator. Quali sono le migliori pratiche per leggere il codice non documentato? Non leggerlo, non è un'opzione:)
Ti suggerisco di raccogliere dati da tutte le possibili fonti.
Usa il codice e inizia a documentarlo da solo. Ovviamente dovrai leggere il codice per capire come funziona, ma anche capire a cosa serve il codice e utilizzarlo in quel modo ti aiuterà a capire. Quanto bene puoi leggere il codice dipende interamente dalla tua comodità con la lingua (o il tipo di linguaggio) e gli algoritmi e i pattern utilizzati.
Leggi la documentazione che circonda il codice. Il codice che chiama questo codice ha una documentazione? Il codice chiamato da questo codice ha una documentazione? Raccogli tutte le informazioni che puoi trovare. Questo può essere ovvio, ma cerca la documentazione che non è allegata al codice, che si tratti di un manuale ufficiale, di un elenco di domande frequenti o di post di un blog.
Se il codice ti sfugge ancora o hai qualche domanda, chiedi alle persone che lo hanno scritto. Passare attraverso il registro di commit e capire chi ha scritto il codice e vedere se sono ancora accessibili. In seguito, invia loro una e-mail o la mailing list del progetto chiedendo se qualcuno potrebbe spiegare cosa fa il codice (specialmente se non è ovvio) e come è stato concepito per essere usato. Poni le tue domande specifiche e spiega il tuo desiderio di scrivere la documentazione per questo.
Passa attraverso un metodo / funzione alla volta e aggiungi la tua documentazione. Continua a rivedere la documentazione mentre impari di più su come tutto funziona.
Leggi altre domande sui tag reading-code