Preguntas sobre cómo escribir comentarios en código.
Mucha gente afirma que "los comentarios deberían explicar 'por qué', pero no 'cómo'". Otros dicen que "el código debe autodocumentarse" y los comentarios deben ser escasos. Robert C. Martin afirma que (reformulado a mis propias palabras) a menudo "los comentarios son disculpas por código mal...
Uno de los miembros de mi equipo siempre evita hacer comentarios en su código. Su código no se documenta por sí mismo, y otros programadores tienen dificultades para comprender su código. Le he pedido varias veces que comente su código, sin embargo, solo da excusas o afirma que lo hará más...
He trabajado en tiendas que producen software crítico para la vida y me he ocupado de las reglas de comentarios destinadas a mantener el código legible y potencialmente salvar vidas. En mi experiencia, sin embargo, el requisito se convierte en una tarea de muerte cerebral para ser eliminada de una...
Un compañero de trabajo mío cree que cualquier uso de comentarios en el código (es decir, no el método de estilo javadoc o los comentarios de clase) es un olor a código . ¿Qué
desarrollador junior aquí. Actualmente estoy trabajando solo en una aplicación web para un gran cliente de mi empresa. Empecé el mes pasado. El cliente quiere al menos el 25% de los comentarios en cada uno de sus proyectos de software. Revisé el código de aplicaciones anteriores y aquí están mis...
Estoy trabajando en un proyecto bastante grande y tuve la tarea de hacer algunas traducciones para él. Hubo toneladas de etiquetas que no se han traducido y mientras buscaba el código encontré este pequeño fragmento de código //TODO translations Esto me hizo pensar en el sentido de estos...
Escribí el siguiente código: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl());
Estoy teniendo algunas conversaciones con mis nuevos colegas sobre los comentarios. A ambos nos gusta Clean Code , y estoy perfectamente de acuerdo con el hecho de que los comentarios de código en línea deben evitarse y que los nombres de clase y métodos deben usarse para expresar lo que...
Sé que Subversion (lo que estamos usando en el trabajo) se puede configurar para requerir comentarios en las confirmaciones, sin embargo, no estoy en una posición de poder para simplemente activar esto. Sé que mi razón para comentar mis confirmaciones es porque es útil, aunque solo sea como un...
En primer lugar, en esta pregunta me gustaría mantenerme alejado de la polémica sobre si los comentarios de código fuente son buenos o malos. Solo estoy tratando de entender más claramente lo que las personas quieren decir cuando hablan de comentarios que te dicen POR QUÉ, QUÉ o CÓMO. A menudo...
Mi jefe me está enseñando (acabo de terminar la escuela y él quería a alguien con un poco de experiencia en programación, así que me eligió para capacitarme en lo que esa compañía se especializa) y comenzó a trabajar con aplicaciones ASP.NET MVC , algunos HTML y CSS . Estoy bien con el material de...
¿Qué quiere decir la gente en general cuando ves XXXen un comentario? De vez en cuando, veo un comentario como este: # XXX - This widget really should frobulate the whatsit Por supuesto, puedo decir qué significa el comentario, pero ¿qué significa generalmente el XXX? ¿Está diciendo "Esto es un...
Acabo de encontrarme escribiendo el siguiente comentario en algún código (arcaico de Visual Basic 6.0) que estaba escribiendo: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if No estoy seguro de por qué inconscientemente uso "nosotros" en mis...
Antecedentes Estoy trabajando en un equipo que busca implementar implementaciones de tiempo de inactividad cero. Estamos planeando usar una estrategia de implementación azul / verde para lograr esto. Una de las cosas de las que me estoy dando cuenta al investigar es lo complicado que resulta hacer...
Alguien dijo una vez que deberíamos prefijar todos nuestros métodos con los /// <summary>bloques de comentarios (C #) pero no explicó por qué. Comencé a usarlos y descubrí que me molestaban bastante, así que dejé de usarlos excepto para las bibliotecas y los métodos estáticos. Son...
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...
¿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...
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...
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...
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...