Preguntas etiquetadas con documentation

¿Por qué la documentación en algunos idiomas dice "equivalente a" en lugar de "es"? Por ejemplo, los documentos de Python dicen itertools.chain(*iterables) ... Equivalente a: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element O esta referencia …

23 c++  python  documentation  compiler 

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 

Parece un poco controvertido el tema de documentar todo, incluida la sintaxis "JavaBean" de captadores y establecedores para campos: la gente dice que es innecesariamente largo y repetitivo romper SECO (no repetir) , que la convención de nomenclatura debería explicar todo , y satura el código / documentación. A veces …

22 documentation 

No puedo contar el número de veces que leo declaraciones en la línea de "las pruebas unitarias son una fuente muy importante de documentación del código bajo prueba". No niego que sean ciertas. Pero personalmente no me he encontrado usándolos como documentación, nunca. Para los marcos típicos que uso, las …

22 unit-testing  documentation 

Actualmente estamos escribiendo especificaciones funcionales y técnicas en un formato de dos columnas; oración resumida y detalles técnicos. Los detalles a menudo se refieren a un apéndice con diagramas, diseños de diseño, etc. Sin embargo, estoy luchando con el tiempo para escribirlo: Con el tiempo pasado como si el trabajo …

21 documentation  specifications  writing 

Antecedentes: mis colaboradores y yo estamos escribiendo un artículo para una revista académica. En el curso de nuestra investigación, escribimos un programa de simulación en Java. Queremos que el programa de simulación esté disponible gratuitamente para que otros lo usen. Hemos decidido alojar el código en un repositorio de GitHub. …

20 java  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 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 6 años . Después de pasar más de un año trabajando en un …

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

A veces, aunque no con frecuencia, tengo que incluir la lógica matemática en mi código. Los conceptos utilizados son en su mayoría muy simples, pero el código resultante no lo es: muchas variables con un propósito poco claro y algunas operaciones con una intención no tan obvia. No quiero decir …

19 java  documentation  math 

Recientemente he estado trabajando en la refactorización de partes de la base de código con la que estoy trabajando actualmente, no solo para comprenderlo mejor, sino también para que sea más fácil para otros que están trabajando en el código. Tiendo a inclinarme al lado de pensar que el código …

18 java  documentation  refactoring  javadocs 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 5 años . Todos saben que el desarrollo de software bien documentado conduce …

18 documentation  wiki 

Suponga que es un desarrollador exclusivo que deja un trabajo. ¿Qué tipo de información / material, fuera del código mismo, debe crear y dejar para su reemplazo? Una respuesta obvia es "lo que quieras en un nuevo trabajo" con seguridad, pero ha pasado un tiempo desde que comencé un nuevo …

18 documentation  knowledge-transfer 

He estado investigando cómo documentar proyectos de software de manera más formal, y he aprendido sobre IEEE 830-1998: Práctica recomendada para especificaciones de requisitos de software . Sin embargo, como puede ver en ese enlace, se ha reemplazado. Sé que 830-1998, y probablemente incluso 830-1993, probablemente estén bien para usar. …

17 documentation  requirements  standards 

Todos hemos visto innumerables ejemplos de software que se entrega con "requisitos mínimos del sistema" como los siguientes: Windows XP / Vista / 7 1 GB de RAM 200 MB de almacenamiento ¿Cómo se determinan estos generalmente? Obviamente, a veces hay restricciones específicas (si el programa toma 200 MB en …

17 documentation  requirements  qa 

Uno de los desarrolladores de mi equipo cree que es necesario escribir un comentario de javadoc para CADA parámetro en la firma de un método. No creo que esto sea necesario, y de hecho creo que incluso puede ser dañino. En primer lugar, creo que los nombres de los parámetros …

17 java  documentation  source-code  comments  maintainability