Considere los marcadores de conflicto. es decir: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD En el caso particular que me motivó a publicar esta pregunta, el miembro del equipo responsable acababa de completar una fusión de aguas...
Escribo mucho código (principalmente c ++ y javascript) que toca la geometría computacional y los gráficos y ese tipo de temas, por lo que descubrí que los diagramas visuales han sido una parte indispensable del proceso de resolución de problemas. Ahora mismo he determinado que "oh, ¿no sería...
Estamos refactorizando una base de código heredada de 20 años, y estoy teniendo una discusión con mi colega sobre el formato de comentarios en el código (plsql, java). No hay un formato predeterminado para los comentarios, pero en la mayoría de los casos las personas hacen algo como esto en el...
Estoy buscando un formato de documentación de clase informativo para mis clases de Entidad, Lógica empresarial y Acceso a datos. Encontré los siguientes dos formatos desde aquí Formato 1 ///----------------------------------------------------------------- /// Namespace: <Class...
Tengo una base de código privada bastante grande que ha evolucionado durante unos diez años. No estoy usando phpDocumentor, pero dado que el uso de secciones docblock se ha convertido en un estándar en proyectos de código abierto, también he adoptado escribir docblocks para todos los métodos...
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 4 años . Para...
¿Es un buen estilo usar variables locales adicionales, técnicamente superfluas, para describir lo que está sucediendo? Por ejemplo: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Cuando se trata de sobrecarga técnica, espero...
Me gustaría saber la mejor manera de agregar un comentario para identificar una clase obsoleta en Java. ¿Debo eliminar el comentario anterior agregado a la parte superior de la clase que ayuda a otro programador a saber para qué era esa clase, o debería agregarlo debajo del
¿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
Estaba hablando con un colega hoy. Trabajamos en código para dos proyectos diferentes. En mi caso, soy la única persona que trabaja en mi código; en su caso, varias personas trabajan en la misma base de código, incluidos los estudiantes cooperativos que van y vienen con bastante regularidad (entre...
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...
Estoy trabajando en un proyecto de "código de espagueti", y mientras estoy arreglando errores e implementando nuevas características, también realizo algunas refactorizaciones para que el código sea comprobable por unidad. El código suele estar tan estrechamente acoplado o complicado que corregir...
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...
Me doy cuenta de que el formato de "comentario de encabezado" varía de programador a programador, pero ¿cuál sería un ejemplo de un comentario de encabezado
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...
¿Es una buena práctica escribir comentarios para métodos ampliamente conocidos como equals, compareTo, etc.? Considere el siguiente código. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for...
Estoy leyendo Clean Code de Robert C. Martin, y la frase TILTaparece inexplicablemente en algunos ejemplos de código. Ejemplo (está en Java, por cierto): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case...
Estoy a punto de abandonar un proyecto, y antes de irme, mi jefe me ha pedido que documente el código (no lo he documentado muy bien). No es gran cosa, el proyecto no es terriblemente complejo. Pero estoy encontrando lugares en mi documentación donde me gustaría decir: "Observe en la línea XYZ que...
Esta podría ser una pregunta estúpida, pero ha estado en mi cabeza por un tiempo y no puedo encontrar una respuesta decente en ningún otro lado. Tengo un maestro que dice que deberíamos enumerar explícitamente cada parámetro con una descripción, incluso si solo hay uno. Esto lleva a mucha...
Quiero escribir Javadoc en SECO. Pero el documento de Oracle sobre Javadoc dice escribir lo mismo nuevamente en el comentario del método de sobrecarga. ¿No puedo evitar la