Ho pubblicato una piccola libreria FOSS (link sotto, ma quello che fa non è molto materiale per questa domanda), su GitHub. Non ha ancora versioni, ma è abbastanza utilizzabile e (sorta) testato.
Ora, ho un robusto documento in prima pagina per il repository - che descrive i principi di progettazione, che fornisce alcuni esempi di mini-snippet di codice e descrive i programmi di esempio disponibili nel repository. Ho anche un rapporto di commento al codice di 3,75 - ma solo alcuni dei miei codici hanno commenti di doxygen, alcuni di questi sono parziali, e un gruppo di informazioni è all'interno del corpo di funzioni / metodi.
Voglio arrivare ad un punto in cui ho documentazione di riferimento per la mia intera libreria - per ogni classe (non interna) e ogni spazio dei nomi, con funzionalità di ricerca, e forse alcuni campanelli e fischietti che non posso ancora nominare. Mi piacerebbe anche che questo fosse "auto-compilato" per quelle parti del codice che non ho specificato i banali commenti Doxygen ( /** adds @p x and @p y \n@param x the left-hand-side number to add \n@param y the right-hand-side number to add \n@return the sum of x and y */ ).
Non ho mai usato effettivamente doxygen prima d'ora. Voglio dire, ho scritto commenti stile doxygen, ma li stavo solo leggendo come un essere umano o con Eclipse li ho usati per i tooltip. Ora mi trovo a chiedermi:
- Dovrei ora cercare il miglior strumento di generazione di documenti offline / online, o dovrei fare più lavoro preparatorio prima (e se sì, di che tipo)?
- Indipendentemente dagli strumenti specifici, dovrei prendere in considerazione la documentazione online o generata dinamicamente, o dovrei limitarmi a farlo da solo e trovando un posto dove ospitarlo?
L'orientamento generale / indicazioni di insidie / difficoltà attese sarebbe apprezzato.
PS: il codice è C ++ e CUDA (+ uno script di bash). Il repository è qui .