¿Cómo escribir comentarios de documentación en ANSI C?[cerrado]

Question

No encuentro cómo escribir comentarios en C.Quiero decir que sé sobre // y /* */, lo que quiero decir es ¿dónde puedo encontrar buenas prácticas?Como si tuviera una función, ¿cómo escribo la @param variable is the value bla bla, como se hace en Java?

¿Existen estándares para esto?¿O puedo simplemente hacerlo como lo hago en Java?

Answer 1

Hay muchos estándares diferentes, si desea generar documentación, intente doxigeno

Answer 2

No existen estándares que sigan el estándar que exige su empresa.
Una forma popular de crear documentación a partir de proyectos es utilizar doxigeno.

Answer 3

Puedes usar el estándar javadoc y luego usar doxigeno que entienda javadoc para generar una documentación.

En doxygen recomiendo usar la opción JAVADOC_AUTOBRIEF ajustado a YES.Si la etiqueta JAVADOC_AUTOBRIEF está configurada en YES, entonces doxygen interpretará la primera línea (hasta el primer punto) de un comentario de estilo Javadoc como una breve descripción.

Ejemplo de definición de clase:

/**
 * A brief description. A more elaborate class description
 * @param bool somebool a boolean argument.
 * @see Test()
 * @return The test results
 */

(Algunos ejemplos más en el manual de doxygen)

La instalación es realmente sencilla, hay una GUI y una bonita visualización gráfica disponible con:

apt-get install doxygen doxygen-gui graphviz

Ejecute la llamada gui doxywizard y utilizar la configuración del asistente, sólo JAVADOC_AUTOBRIEF debe configurarse allí en la configuración "Experto".

Answer 4

Una opción es utilizar el formato doxygen para escribir comentarios; esto tiene el beneficio adicional de poder generar html/latex y otros tipos de documentos para su código.