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...
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...
<body> <!-- wrapper --> <div id="wrapper"> <!-- title --> <div id="title"><img src="title.png" alt="" /></div> <!-- form wrapper --> <div id="form_wrapper"> <!-- form --> <form action="thankyou.php" method="POST">...
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...
¿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
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...
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 sentir...
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....
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...