Preguntas etiquetadas con documentation

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 objetivo es tener un sistema de documentación en línea, …

11 documentation 

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 una …

11 agile  documentation  architecture  dry 

Tal como está actualmente, esta pregunta no es adecuada para nuestro formato de preguntas y respuestas. Esperamos que las respuestas estén respaldadas por hechos, referencias o experiencia, pero esta pregunta probablemente solicitará debate, argumentos, encuestas o discusión extendida. Si cree que esta pregunta se puede mejorar y posiblemente volver a …

11 project-management  business  management  documentation 

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 método (por …

11 c#  .net  documentation  reflection 

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 una …

11 documentation  comments 

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 ese?

11 unit-testing  documentation 

Creamos una biblioteca comercial y ejemplos de código que están siendo utilizados por desarrolladores externos. Tenemos documentación (cerrada, disponible para usuarios registrados) que explica ampliamente cómo usar la biblioteca. Muchos de los desarrolladores son usuarios nuevos, por lo que se encuentran muchos errores rudimentarios. ¿Es apropiado incluir enlaces a la …

10 documentation  api-design  error-handling  error-messages 

Soy un desarrollador aficionado y todos mis programas hasta ahora eran lo suficientemente simples como para documentarse en el código. Mientras leía el código, estaba claro lo que estaba haciendo tal y tal acción (mi prueba estándar fue mirar el código 6 meses después y entender todo a la primera …

10 architecture  documentation 

Soy el único desarrollador de un proyecto que, como cualquier proyecto de software, puede ser tomado por otra persona en el futuro. Digamos que usé el patrón X para implementar la característica A. Después de desarrollar y terminar la característica, me doy cuenta de que podría implementar la misma característica …

10 design-patterns  refactoring  documentation 

¿Qué información esperarías ver en el archivo README de github? ¿Debería ir todo en el archivo README? es decir Introducción Instalación Versiones Guía del usuario Implementación Pruebas Recursos Relacionados ¿O debería simplemente poner ciertas cosas en el archivo README (Introducción, Instalación, Versiones) y la otra información se ubica mejor en …

10 documentation  github 

Solía ​​ser un fanático de requerir comentarios XML para la documentación. Desde entonces he cambiado de opinión por dos razones principales: Como un buen código, los métodos deben explicarse por sí mismos. En la práctica, la mayoría de los comentarios XML son ruidos inútiles que no proporcionan ningún valor adicional. …

10 .net  programming-practices  development-process  documentation  comments 

Estamos usando métodos ágiles en mi proyecto actual en este momento, y tenemos un montón de historias como estas: Como asistente, quiero pagar un reembolso a un cliente para que pueda obtener algo de dinero cuando lo solicite. Como cliente, quiero pagar una compra para poder recibir mi artículo. Lo …

10 agile  documentation  requirements  user-story 

Donde trabajo actualmente es el enfoque general: evitar la documentación tanto como sea posible Solo documente si un equipo diferente lo necesitará solo para aclarar, no me refiero a la documentación del código; esto lo hacemos, me refiero a toda la documentación que rodea el proceso de diseño, si se …

10 documentation 

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 . El equipo en el que formo parte actualmente experimenta una rotación bastante …

10 documentation  training 

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 Studio. Sin embargo, hay …

10 documentation  comments  intellisense