Domanda

Ho alcuni codici grandi e per lo più procedurali che devono essere ben documentati.Ciò comporta generalmente l'uso ripetuto di un numero di funzioni che devono essere eseguite in un determinato ordine.

Doxygen è un ottimo prodotto, ma sembra molto orientato a documentare i codici OOP.Qualcuno ha qualche consiglio su come usare Doxygen in modo naturale per documentare il lavoro procedurale?

È stato utile?

Soluzione

Non c'è nulla di intrinsecamente OOP sul modo in cui i lavori di Doxygen.È solo in grado di estrarre ulteriori informazioni sul codice OO perché ha maggiori informazioni in esso (ad esempio ereditariera).

Utilizziamo DOXYGEN per il codice C a livello C e funziona altrettanto bene, meno le informazioni che BianL CA non forniscono rispetto a C ++.Basta usare le funzionalità di Gruppo di Doxygen (@addtGroup et al) per organizzare la documentazione generata e stai bene da fare.

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top