2012-10-17 14 views
32

Voglio provare i generatori di documentazione per un nuovo progetto in C++. Penso che le mie opzioni siano Doxygen o Sfinge. Dato che ho progetti in Python per i quali mi piacerebbe usare Sphinx, mi chiedo se Sphinx sia la scelta giusta anche per C++. Il sito Web Sphinx afferma che C++ è supportato, ma non sono riuscito a trovare un documento per farmi iniziare con la documentazione C++.La Sfinge è già adatta alla documentazione C++?

Una domanda simile è già stato discussed on Stackoverflow e la risposta principale conclude:

non ancora completamente utilizzabile,
ma continuare a guardare

Dal momento che la discussione è ben più di un anno , Mi chiedo se questa conclusione sia ancora valida. Dovrei scegliere Doxygen over Sphinx per la mia documentazione C++?

+3

Non so di Sphinx, ma penso che Doxygen sia davvero un ottimo strumento! Che problemi hai trovato su Doxygen? – lucasg

+3

@georgesl L'unico problema che ho con Doxygen al momento è che userò Sphinx per i miei progetti Python e voglio evitare di usare due diversi sistemi di documentazione. Probabilmente ci vuole tempo per iniziare con ciascuno di essi e abituarsi alla sintassi. – clstaudt

+0

Nella sidebar di destra sul loro sito web, c'è un collegamento a un gruppo Google e un handle di chat di FreeNode. Hai provato quelli? Non sto dicendo necessariamente che questa domanda non appartiene a questo, solo che penserei che sarebbe più probabile avere una risposta informata lì. –

risposta

18

Sphinx non può estrarre la documentazione dai sorgenti C++ da sola. Tuttavia, esistono estensioni, in particolare Breathe, che utilizzano Doxygen per estrarre la documentazione da C++. Non ho provato nessuno di questi.

+0

Sembra che io abbia ancora bisogno di usare la strana sintassi di Doxygen se uso Breathe. : - / –

0

Per C++ Doxygen è molto buono; Il supporto Sphinx di C++ è fatto tramite Doxygen (usando Breathe).

Si desidera avere un solo strumento per le due lingue, per migliorare la manutenibilità. Doxygen can generate a documentation from Python code, quindi ti consiglio di utilizzare Doxygen per entrambe le sorgenti, se possibile. Here is a tutorial for Doxygen and Python.

+18

Ho in anni di programmazione Python mai visto alcun progetto Python usando Doxygen. È assolutamente uno strumento non standard nella comunità Python, ed è diverso dal fatto che troverai molto aiuto nel caso avessi problemi. – lunaryorn

+1

L'argomento è "Doxygen fa male a Python perché nessuno lo usa"? Ci dispiace, ma questo non è vero. Ad esempio, vedi http://code.foosel.org/doxypy, http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks, http://engtech.wordpress.com/2007/03/20/automatic_documentation_python_doxygen/(quindi ci sono persone interessate a Doxygen con Python). – Synxis

+7

Alcuni risultati di Google non battono in realtà la mia affermazione che si tratta di uno strumento non standard nella comunità. L'uso diffuso di Doxygen in progetti importanti sarebbe, ma non ce n'è. Nessun progetto Python considerevole utilizza Doxygen per la documentazione, o lo ha fatto in passato. Diamine, nemmeno Zope ... – lunaryorn

Problemi correlati