Pregunta

Tengo algunos códigos de procedimiento grandes, sobre todo, que deben estar bien documentados.Esto generalmente implica el uso repetido de una serie de funciones que deben ejecutarse en un determinado orden.

Doxygen es un gran producto, pero parece muy orientado a documentar los códigos OOP.¿Alguien tiene algún consejo sobre cómo usar Doxygen de forma natural de documentar el trabajo de procedimiento?

¿Fue útil?

Solución

No hay nada intrínsecamente oop sobre la forma en que funciona Doxygen.Es capaz de extraer más información sobre el código OO porque tiene más información en ella (por ejemplo, gráficos de herencia).

Utilizamos Doxygen para el código CLAND C y también funciona igual, menos la información que no se proporciona, no se proporciona en comparación con C ++.Simplemente use las características de Agrupación de Doxygen (@AddtoGroup et al) para organizar la documentación generada y usted es bueno hacerlo.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top