El Principio DRY (No te repitas) establece que "cada conocimiento debe tener una representación autoritaria, inequívoca y única dentro de un sistema". La mayoría de las veces esto se refiere al código, pero a menudo también se extiende a la documentación. Se dice que cada sistema de software tiene...
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 . El...
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 . Siempre me he...
Después de mucho buscar, no he podido responder una pregunta básica relacionada con un supuesto conocido en el mundo del desarrollo de software: LO QUE SE SABE: La aplicación de una política estricta sobre la documentación adecuada del código (ya sea etiquetas Doxygen, Javadoc o simplemente una...
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 2 años .
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 5 años . He estado...
Quiero mejorar mis habilidades de programación estudiando famosos proyectos de código abierto, pero creo que es fácil perderse simplemente saltando a su código fuente. Así que decidí leer su documentación sobre su diseño o arquitectura (como los diagramas UML) para tener una idea general sobre la...
Nuestro software tiene varias clases que se deben encontrar dinámicamente a través de la reflexión. Todas las clases tienen un constructor con una firma específica a través de la cual el código de reflexión crea instancias de objetos. Sin embargo, cuando alguien comprueba si se hace referencia al...
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...
Actualmente estoy trabajando en mi graduación para mis estudios de "Desarrollo de software", en los que tengo que desarrollar software complejo individualmente en una empresa externa. Todo esto debe hacerse de manera estructurada, creando todos los documentos correspondientes. Para este proyecto,...
En mi opinión, los casos de prueba de la unidad en sí sirven como documentación para el código. Mi empresa quiere que escriba comentarios detallados de java doc sobre los casos de prueba de unidad. ¿Es necesario hacerlo? ¿Escribes comentarios como
Ocasionalmente, existe el 1% del código que es computacionalmente lo suficientemente intensivo y necesita el tipo más pesado de optimización de bajo nivel. Ejemplos son el procesamiento de video, el procesamiento de imágenes y todo tipo de procesamiento de señales, en general. Los objetivos son...
Tengo un proyecto para la universidad que no comenzaré de inmediato, pero he estado pensando durante un período de tiempo razonablemente largo. Entiendo que el desarrollo de proyectos universitarios no es como la industria (actualmente soy un interno), por lo que la situación que señalaré en este...
Cuando escribo pequeños scripts para mí, apilo mi código con comentarios (a veces comento más de lo que codifico). Muchas personas con las que hablo dicen que debería documentar estos guiones, aunque sean personales, de modo que si alguna vez los vendo, estaría listo. ¿Pero no son los comentarios...
¿Existen prácticas comunes para comentar las expresiones regulares: comentarios en línea que hacen referencia a diferentes partes de RegEx o comentarios generales para todas las
Cerrado. Esta pregunta está fuera de tema . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que sea sobre el tema de Software Engineering Stack Exchange. Cerrado hace 6 años . Soy un defensor de...
Tenemos muchos documentos asociados con nuestro desarrollo de software. Estos incluyen cosas como requisitos, documentos de diseño, archivos PDF externos, archivos de clientes, instrucciones de prueba, etc. Actualmente, estos documentos están dispersos por todas partes (wiki, "algún lugar en la...
Es difícil saber qué se pregunta aquí. Esta pregunta es ambigua, vaga, incompleta, demasiado amplia o retórica y no se puede responder razonablemente en su forma actual. Para obtener ayuda para aclarar esta pregunta y poder volver a abrirla, visite el centro de ayuda .
Una parte central del diseño impulsado por dominio es el uso constante de un lenguaje ubicuo en todo el sistema: en conversaciones, código, esquema de base de datos, interfaz de usuario, pruebas, etc. Estoy involucrado en un proyecto en el que ya existe un lenguaje de dominio bien establecido,...
Soy un defensor del código debidamente documentado, y soy muy consciente de las posibles desventajas del mismo . Eso está fuera del alcance de esta pregunta. Me gusta seguir la regla de agregar comentarios XML para cada miembro público, considerando cuánto me gusta IntelliSense en Visual...