Preguntas etiquetadas con comments

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 comentarios sobre el control de versiones, ¿qué hacen / …

12 comments  source-code 

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 públicos en mi …

12 php  comments 

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 un pequeño error daría como resultado que se reescriban …

11 refactoring  comments 

¿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 expresiones?

11 documentation  coding-style  comments 

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

11 coding-style  team  comments 

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

11 java  code-quality  api  comments 

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 

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 

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 

¿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 equals } Mi empresa se obliga …

10 java  comments 

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 "bueno"?

10 c++  coding-style  comments  code-formatting  headers 

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 ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case ErrorCode.MISSING_ARGUMENT: …

9 java  clean-code  comments  conventions 

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 …

9 documentation  comments 

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 repetición?

9 documentation  comments  dry  javadocs 

Tal como está actualmente, esta pregunta no es adecuada para nuestro formato de preguntas y respuestas. Esperamos que las respuestas sean 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 …

9 comments