Preguntas etiquetadas con comments

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. /// </summary> public int ID { …

19 c#  .net  programming-practices  comments 

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 práctica?

18 comments  issue-tracking 

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 idea.

18 language-agnostic  syntax  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 . A menudo he visto que se usan tales comentarios: function …

18 source-code  comments 

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 TFS para el …

17 coding-standards  comments 

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 …

17 java  documentation  source-code  comments  maintainability 

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: // We're now …

16 comments 

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

15 .net  comments  coding  exceptions 

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 . Cerrado hace 8 años . …

15 comments 

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 extendida. Si cree que esta pregunta se puede mejorar y posiblemente volver a …

15 comments 

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 arriba a nuestra sucursal, y en algunos casos los …

14 version-control  comments  coding-style 

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 fantástico si …

14 productivity  code-reviews  comments  workflows  image-manipulation 

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 …

13 java  c#  programming-practices  code-quality  comments 

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 Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// …

13 c#  documentation  comments 

¿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 que el compilador optimice esta línea adicional. ¿Pero se considera un …

12 coding-style  comments