Hablaré sobre diversos generadores de documentación técnica. Espero les sirva para elegir el que mejor se adapte a sus necesidades y sobre todo al lenguaje que estén manejando:
Doxygen:
Lenguajes: C, C++, Objective-C, Java, Python, IDL, PHP, C#, D.
Es muy adaptable, y gracias a eso funciona tanto el Windows como en distribuciones Unix.
JavaDoc
Lenguajes: Java.
Genera documentación HTML a partir de archivos de clases en Java. Deben usarse tags de HTML seguidas por @ un arroba. Se escriben al inicio de cada clase o método del que se quiera documentar. Con comentarios que comienzan con: /** y terminan con */
@autor: Persona que elaboró el código y la documetanción
@deprecated: Indica que esta función es vieja y podría llegar a desaparecer con el paso de las versiones posteriores.
@param: Define parámetros de un método
@return: Informa sobre lo que devuelte dicho método.
@see: Se asocia con otra clase o método
@throw: Arroja excepciones
@version: Versión de la clase o método.
Epydoc
Lenguajes: Python
Autogenera documentación de códigos hechos solamente en Python. Arroja resultados en forma de archivos en HTML, muy parecidos a los de JavaDoc. Sencillo de utilizar, no viene instalado default con Python, si lo queremos descargar, seguimos con la instrucción: sudo apt-get install python-epydoc
Fuentes: http://sudokill.blogspot.com/2011/03/epydoc-como-documentar-en-python-de.html
http://es.wikipedia.org/wiki/Javadoc
http://es.wikipedia.org/wiki/Anexo:Comparativa_de_generadores_de_documentaci%C3%B3n
No hay comentarios:
Publicar un comentario