Preguntas etiquetadas con comments

Preguntas sobre cómo escribir comentarios en código.

Comentarios / Estilos de documentación en código

Esta podría ser una pregunta estúpida, pero ha estado en mi cabeza por un tiempo y no puedo encontrar una respuesta decente en ningún otro lado. Tengo un maestro que dice que deberíamos enumerar explícitamente cada parámetro con una descripción, incluso si solo hay uno. Esto lleva a mucha repetición: …

9 documentation comments coding-style

¿Es generalmente útil incluir problemas de JIRA en los comentarios de código?

De vez en cuando, dejo comentarios como # We only need to use the following for V4 of the computation. # See APIPROJ-14 for details. o # We only need to use the following for V4 of the computation. # See https://theboringcompany.atlassian.net/browse/DIGIT-827 for details. Mi principal preocupación al hacerlo es …

8 project-management coding-style communication comments jira

¿Leer javadoc es preferible a leer el código fuente para familiarizarse con una biblioteca?

Acabo de encontrar lo siguiente en un manual de laboratorio en la universidad: Es necesario estudiar las interfaces de las clases generando el javadoc para ellas para que sepa qué operaciones se proporcionan (siéntase libre de mirar el código, pero cuando use el código de otra persona, como aquí, debe …

8 source-code comments javadocs

¿Por qué algunas bibliotecas de openouce carecen de comentarios?

No sé si esto le sucede a la mayoría de las bibliotecas de código abierto, pero muchas de las que conozco y utilizo (por ejemplo, OpenSSL, Webkit, ...) todas carecen de comentarios o contienen muy pocos comentarios. Sin mencionar sus muy pocos documentos, es difícil leer su código fuente. Difícilmente …

8 open-source libraries comments document

¿Debería la sintaxis para deshabilitar el código diferir de la de los comentarios normales?

Por varias razones durante el desarrollo, a veces comento código. Como soy caótico y a veces tengo prisa, algunos de estos llegan al control de la fuente. También uso comentarios para aclarar bloques de código. Por ejemplo: MyClass MyFunction() { (...) // return null; // TODO: dummy for now return …

8 comments syntax

<! - open -> ¿Por qué tantos desarrolladores hacen esto en su HTML? <! - / cerrar ->

<body>  <div id="wrapper">  <div id="title"><img src="title.png" alt="" /></div>  <div id="form_wrapper">  <form action="thankyou.php" method="POST">  </form>  </div>  </div>  </body> Casi puedo entenderlo al …

8 comments html

¿Cómo se expresan los comentarios en las gramáticas del lenguaje de programación?

Estoy aprendiendo cómo construir analizadores usando gramáticas, pero me quedé atrapado tratando de expresar comentarios, porque pueden aparecer en casi cualquier lugar. Esto indica que los comentarios se pueden quitar de la secuencia de tokens antes de que se realice el análisis. ¿Es esa la práctica estándar, o los comentarios …

8 comments parsing grammar

¿El estilo de comentario afecta la forma en que los lectores entienden el código?

Esta pregunta me ha estado obsesionando durante los últimos 2 meses. Hace un tiempo, un amigo que es un gran programador me dio algunos códigos de ejemplo, y por primera vez noté un estilo único de organización de comentarios. Se esforzó por diseñar comentarios de una manera que me hiciera …

8 comments

¿Qué debo poner en los comentarios al comprometerme con el Control de código fuente?

¿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. Soy un desarrollador solitario y mantengo un servidor SVN para el control de código fuente. Hasta ahora, no …

8 version-control comments

Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.

Licensed under cc by-sa 3.0 with attribution required.