Preguntas etiquetadas con documentation-generation

El desarrollo basado en el comportamiento con su emblemática sintaxis de escenarios "dado-cuándo-entonces" últimamente ha sido muy publicitado para sus posibles usos como un objeto límite para la evaluación de la funcionalidad del software. Definitivamente estoy de acuerdo en que Gherkin , o la secuencia de comandos de definición de …

24 documentation  bdd  documentation-generation  business-rules 

Cerrada . Esta pregunta necesita estar más centrada . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que se centre en un problema solo editando esta publicación . Cerrado el año pasado . Quiero documentar mi código de tal manera que haya una mínima necesidad …

22 documentation  code-reviews  documentation-generation  help-documentation 

Entonces tenemos una interfaz como esta /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Recientemente, reprodujimos una historia de documentación que …

20 c#  documentation  xml  documentation-generation 

Actualmente estoy usando dos sistemas para escribir documentación de código (estoy usando C ++): La documentación sobre métodos y miembros de la clase se agrega al lado del código, utilizando el formato Doxygen. En un servidor, Doxygen se ejecuta en las fuentes para que la salida se pueda ver en …

13 documentation  documentation-generation  wiki 

¿Existe un buen término que sea similar pero diferente de "desaprobar" para significar que un método o API está en la base del código pero que no debe usarse porque su implementación no está completa o probablemente cambiará? (Sí, lo sé, esos métodos no deberían ser públicos, yada yada yada. …

12 documentation  terminology  api  documentation-generation  javadocs 

Cerrada . Esta pregunta necesita estar más centrada . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que se centre en un problema solo editando esta publicación . Cerrado hace 4 años . He completado una aplicación web que se desarrolla básicamente en PHP y …

11 project-management  documentation  documentation-generation  projects-and-solutions 

He documentado mi código doxygen, pero no quiero el HTML predeterminado que proporciona. Sé que puedo personalizarlo al proporcionar CSS personalizado, encabezados, pies de página, etc. (como lo hace GNOME), y cómo puedo agregar código PHP común a los archivos y decirle que guarde como .php, pero eso no es …

10 documentation  templates  documentation-generation 

He desarrollado algunas bibliotecas cuantitativas en C # donde es importante comprender no solo la información clásica que acompaña a los comentarios XMLDoc (que contiene información básica con la firma del método) sino también las fórmulas matemáticas que se utilizan dentro de los métodos. Por lo tanto, me gustaría poder …

8 documentation  documentation-generation