¿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...
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...
¿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...
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...
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...
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 como...
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...
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....
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...
Estoy buscando una recomendación de una mejor práctica para comentarios XML en C #. Cuando crea una propiedad, parece que la documentación XML esperada tiene la siguiente forma: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. ///...
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...
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 . A menudo...
Vi muchos números de problemas de los comentarios del código jQuery . (En realidad, había 69 números de problema en el código jQuery). Creo que sería una buena práctica, pero nunca he visto ninguna guía. Si es una buena práctica, ¿cuáles son las pautas para esta
Algunos lo hacen, pero no ninguno de los populares, que yo sepa. ¿Hay algo malo en anidar comentarios? Planeo que los comentarios de bloque aniden en el idioma (pequeño) en el que estoy trabajando, pero me gustaría saber si es una mala
El desarrollador principal de nuestra tienda insiste en que cada vez que se modifica el código, el programador responsable debe agregar un comentario en línea que indique lo que hizo. Estos comentarios generalmente se ven como// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Usamos...
Uno de los desarrolladores de mi equipo cree que es necesario escribir un comentario de javadoc para CADA parámetro en la firma de un método. No creo que esto sea necesario, y de hecho creo que incluso puede ser dañino. En primer lugar, creo que los nombres de los parámetros deberían ser...
En bastante base de código puede ver comentarios que indican cosas como: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Así que tengo algunas preguntas, pero todas están relacionadas. ¿Está bien poner un enlace a las preguntas SO en los comentarios de un programa: //...
¿Se considera una mala práctica lanzar NotImplementedExceptionun código que aún no has escrito? ¿Posiblemente TODOS los comentarios se considerarían más
Es difícil saber qué se pregunta aquí. Esta pregunta es ambigua, vaga, incompleta, demasiado amplia o retórica y no se puede responder razonablemente en su forma actual. Para obtener ayuda para aclarar esta pregunta y poder volver a abrirla, visite el centro de ayuda .
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