No encuentro cómo escribir comentarios en C. Quiero decir, sé acerca de // y /* */, lo que quiero decir es ¿dónde puedo encontrar buenas prácticas? Al igual que si tengo una función, ¿cómo escribo el @param variable is the value bla bla, como se hace en Java?Cómo escribir comentarios de documentación en ANSI C?
¿Hay alguna norma para esto? ¿O puedo hacerlo como lo hago en Java?
Hay muchas normas diferentes, si se desea generar documentación, trate doxygen
No existen normas siguen el estándar que sus mandatos compañía.
Una forma popular de crear documentación de proyectos es usar Doxygen.
Una opción es utilizar el formato doxygen de escribir comentarios; esto tiene la ventaja adicional de poder generar html/latex y otras clases de documentos para su código.
Puede usar el estándar javadoc y luego usar doxygen que comprende javadoc para generar una documentación.
En doxygen recomiendo usar la opción JAVADOC_AUTOBRIEF establecida en YES. Si la etiqueta JAVADOC_AUTOBRIEF está configurada en SÍ, entonces doxygen interpretará la primera línea (hasta el primer punto) de un comentario al estilo de Javadoc como la breve descripción.
Ejemplo de una 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 in the doxygen manual)
La instalación es muy simple, hay una interfaz gráfica de usuario y una bonita visualización gráfica disponible con:
apt-get install doxygen doxygen-gui graphviz
Ejecute la interfaz gráfica de usuario llamando al doxywizard y use la configuración del asistente, solo JAVADOC_AUTOBRIEF tiene que establecerse en el ajuste "Experto" ings.
Una buena respuesta con un ejemplo. – Drew
En realidad, ni siquiera puede usar '//' en ANSI C. Solo desde C99 permitieron '//'. (Aunque GCC lo permite como una extensión.) – Mysticial
Sólo '/ * * /' es compatible con C. '//' es una adición en C++ –
El término "ANSI C" generalmente se refiere al lenguaje descrito por el estándar ANSI de 1989 , pero estrictamente hablando eso es incorrecto. En 1990, ISO emitió el mismo estándar (con algunas nuevas materias introductorias y secciones renumeradas), y ANSI lo adoptó. En 1999, ISO emitió un nuevo estándar C, y ANSI lo adoptó también, convirtiendo el estándar 1989/1990 oficialmente obsoleto. A fines de 2011, ISO emitió otro nuevo estándar C, que ANSI también adoptó. Excepto por el primero, los estándares C son publicados inicialmente por ISO, no por ANSI, y es mejor consultar los estándares por año. –