Preguntas etiquetadas con comments

Se nos ha pedido que agreguemos comentarios con etiquetas de inicio, etiquetas finales, descripción, solución, etc. para cada cambio que realicemos en el código como parte de la corrección de un error / implementación de un CR. Mi preocupación es, ¿esto proporciona algún valor agregado? Tal como están las cosas, …

42 version-control  bug  comments  change 

¿Es una buena práctica poner números de error en el archivo dentro de un comentario de encabezado? Los comentarios se verían así: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description Parece útil, …

40 version-control  development-process  source-code  comments 

Constantemente veo personas que afirman que "los comentarios tienden a quedar desactualizados". La cuestión es que creo que he visto quizás dos o tres comentarios desactualizados en toda mi carrera. La información desactualizada en documentos separados ocurre todo el tiempo, pero en mi experiencia los comentarios desactualizados en el código …

38 comments  myth 

Durante el transcurso de la programación, terminarás con algunos comentarios que explican el código y algunos comentarios que eliminan el código: // A concise description const a = Boolean(obj); //b = false; ¿Existe un buen método para analizar rápidamente cuál es cuál? He jugado con el uso de 3 /y …

38 javascript  comments 

Suponiendo un comentario no se ajusta (o no puede ir) en la línea que se aplica, debe uno escribir el comentario antes del código o después? Bueno, donde los futuros lectores comprendan mejor el alcance del comentario. En otras palabras, donde la mayoría de los programadores / scripters ponen tales …

34 comments 

¿Cómo se tratan generalmente los comentarios en lenguajes de programación y marcado? Estoy escribiendo un analizador para un lenguaje de marcado personalizado y quiero seguir el principio de menor sorpresa , así que estoy tratando de determinar la convención general. Por ejemplo, ¿debería un comentario incrustado dentro de un token …

31 parsing  comments 

¿Quieres mejorar esta publicación? Proporcione respuestas detalladas a esta pregunta, incluidas citas y una explicación de por qué su respuesta es correcta. Las respuestas sin suficiente detalle pueden ser editadas o eliminadas. Esta pregunta se migró de Stack Overflow porque se puede responder en Software Engineering Stack Exchange. Migrado hace …

27 language-agnostic  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 5 años . Vi esto en la taberna SO , así que publico …

27 source-code  comments  coding-style  grammar 

Esta pregunta se migró de Stack Overflow porque se puede responder en Software Engineering Stack Exchange. Migrado hace 8 años . Quiero saber de usted cualquier consejo y experiencia de escribir comentarios en su código. ¿Cómo los escribes de la manera más fácil e informativa? ¿Qué hábitos tienes al comentar …

26 coding-style  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 . Recién estoy comenzando con la programación funcional y me pregunto …

25 functional-programming  comments 

Aparece no solo en un idioma que los comentarios no se pueden anidar. ¿Tienes una buena solución para este problema? Una solución alternativa en C / C ++ y Java es usar solo el comentario de una sola línea, pero resulta imposible comentar un bloque más grande. Estoy enfrentando algo …

23 java  c++  python  c  comments 

Bloqueado . Los comentarios sobre esta pregunta se han deshabilitado, pero aún acepta nuevas respuestas y otras interacciones. Más información . Tuve una búsqueda pero no encontré lo que estaba buscando, no dude en vincularme si esta pregunta ya se ha formulado. A principios de este mes se hizo esta …

22 coding-standards  comments 

Siempre que descubro que es necesario cambiar una gran parte de mi código, ya sea porque es incorrecto o porque debe adaptarse a los principales cambios arquitectónicos necesarios por otros motivos, esto es lo que hago normalmente: Comento todo el código que sospecho que podría tener que cambiar. Trato el …

21 anti-patterns  comments 

Esta pregunta se migró de Stack Overflow porque se puede responder en Software Engineering Stack Exchange. Migrado hace 7 años . Comentar hoy en día es más fácil que nunca. En Java, hay algunas buenas técnicas para vincular comentarios a clases, y los IDE de Java son buenos para hacer …

20 java  python  clojure  comments 

De algunos proyectos de código abierto, reuní el siguiente estilo de codificación void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Siempre tengo dudas sobre lo que falsesignifica aquí. ¿Significa "olvidar", o "olvidar" se refiere a su parámetro correspondiente (como en el caso anterior), y "falso" tiene la …

19 coding-style  comments  boolean