¿Cómo se debe comentar un código?

Preguntado por: Ander Ferrer Tercero  |  Última actualización: 10 de abril de 2022
Puntuación: 4.2/5 (50 valoraciones)

Para que nuestro código sea elegante, limpio y fácil de mantener, podemos seguir los siguientes consejos.
  1. Utiliza nombres descriptivos. ...
  2. Los comentarios tienen que ser útiles. ...
  3. Piensa si un comentario es necesario antes de añadirlo. ...
  4. Evita comentarios dentro de métodos o funciones. ...
  5. No comentes código eliminado.

¿Cómo comentar un código?

Cómo comentar en HTML

Dentro de tu código deberás abrir una etiqueta HTML como haces habitualmente, con el símbolo de «menor que». Seguido irá un cierre de exclamación y dos guiones. Para cerrar el comentario deberás poner dos guiones y luego el símbolo de «mayor que».

¿Cómo comentar código C++?

Los comentarios de C++ se escriben de una de las maneras siguientes:
  1. Los caracteres /* (barra diagonal, asterisco), seguidos de cualquier secuencia de caracteres (incluidas nuevas líneas), seguidos de los caracteres */ . ...
  2. Los caracteres // (dos barras diagonales), seguidos de cualquier secuencia de caracteres.

¿Cuáles son las instrucciones para hacer un comentario dentro del código en el lenguaje C?

Comentar código
  • En el editor C/C++, seleccione la línea o las líneas de código que desea comentar. Si no se seleccionan líneas, se añadirán comentarios (o se eliminarán) en la posición del cursor actual.
  • Pulse con el botón derecho y seleccione Fuente > Conmutar comentario. ( CONTROL+/ )

¿Cómo se pueden introducir comentarios?

Insertar, eliminar o modificar un comentario
  1. Seleccione el texto sobre el que desee hacer un comentario o haga clic al final del texto.
  2. En la pestaña Revisar, haga clic en Nuevo comentario.
  3. Escriba su comentario. Word muestra el comentario en un globo en el margen del documento.

Como comentar nuestro codigo | buenas prácticas

41 preguntas relacionadas encontradas

¿Cómo poner comentarios en documentos?

Cómo agregar, editar, ver, filtrar o eliminar comentarios
  1. En la computadora, abre un documento, una hoja de cálculo o una presentación.
  2. Destaca el texto, las imágenes, las celdas o las diapositivas que quieras comentar.
  3. Para agregar un comentario, en la barra de herramientas, haz clic en Agregar comentario .

¿Cuándo se usan los comentarios?

La función de comentarios es una forma eficaz de dar opiniones o hablar sobre los elementos de una presentación. Los colaboradores con derechos para editar o comentar en una presentación pueden añadir comentarios, por lo que colaborar es más simple y eficiente.

¿Cómo se escriben los comentarios en lenguaje C de una sola línea?

Comentarios de Una Sola Línea: Pueden ser colocados en cualquier parte y comienzan por un doble slash "//", al colocar el doble slash al comienzo de cualquier línea de código, todo lo que halla de ahí en adelante en esa misma línea será tomado como comentario, ten en cuenta que el doble slash solo convierte en ...

¿Cómo se hace un comentario en HTML?

Un comentario HTML comienza con <! –– y el comentario se cierra con ––> . Los comentarios HTML son visibles para cualquiera que vea el código fuente de la página, pero no se representan cuando el navegador procesa el documento HTML.

¿Qué es comentario en HTML?

Los comentarios en HTML son unos trocitos de código que nos permiten introducir en nuestra página web contenidos que no se van a ver en el navegador. Si quieres verlos, vas a tener que meterte en el código fuente de la web (“botón derecho->ver código fuente" o algo similar, depende del navegador).

¿Qué es comentarios HTML?

Se llama comentario en el ámbito de HTML las notas que el autor o autores ponen en el código para facilitar su entendimiento. Estos comentarios no son mostrados por el navegador y por tanto sólo serán visibles al leer el código HTML de la página web.

¿Cómo hacer comentarios en HTML Sublime Text?

Por defecto el atajo de teclado para comentar textos en Sublime Text es Ctrl + /, sin en efecto esto funciona para la configuración de teclado en inglés, tanto en Windows como en MAC.

¿Qué símbolos se utilizan para comentarios de una sola línea?

Comentarios de una sola línea.

Para comentariar una sola línea se utiliza la doble diagonal //.

¿Qué es un comentario y cuál es su función?

El comentario es un texto que tiene el propósito de presentar el texto comentado y explicarlo. En este sentido, el comentario de texto debe: -Presentar la organización del texto comentado. -Presentar los componentes de la estructura interna del texto comentado.

¿Que son y para que se utilizan los comentarios en un programa?

Los comentarios son anotaciones que el programador incorpora a su código fuente para hacerlo más entendible. Estas líneas son ignoradas por el ordenador cuando se ejecuta el programa, por lo que son inocuas para la obtención del resultado final.

¿Cuáles son los tipos de comentarios?

INFORMATIVO: en este tipo de comentario lo esencial son los hechos escuetos y precisos. Su forma debe ser de tipo narrativo-expositiva. INTERPRETATIVO: en el que, además de los hechos, se agregan otros elementos -causa o efectos- relacionados con esos hechos para valorarlos a la luz de la razón.

¿Qué son los comentarios en un documento de Word?

Use comentarios para hacer preguntas y realizar sugerencias o correcciones sin cambiar el texto. Los comentarios hacen referencia a un lugar específico del documento que elija seleccionando una sección de texto o simplemente haciendo clic o pulsando en el documento.

¿Cómo hacer un comentario en CSS?

Notas. La sintaxis de comentarios /* */ es usada para comentarios de una o múltiples líneas. No hay otra forma de especificar comentarios en hojas de estilos externas. Sin embargo, cuando se usa el elemento <style> , se puede usar <!

¿Cómo hacer un comentario en XML?

Un comentario comienza con <! -- y termina con -->. Puede agregar notas de texto como de los comentarios entre los personajes. Usted no debe anidar un comentario dentro de la otra.

¿Cómo hacer un comentario en JSON?

No los comentarios en JSON no están permitidos. Esta respuesta se basa en: http://www.json.org. RFC 4627 : El application/json Tipo de medios para la notación de objetos JavaScript (JSON)

¿Qué es un archivo XML ejemplos?

XML son las siglas de Extensible Markup Language, que podemos traducir como Lenguaje de Marcas Extensibles, aunque realmente es un meta-lenguaje. Normalmente, los archivos XML contienen información de cualquier tipo, ya sea información sensible o información de cualquier ámbito.

¿Qué es un atributo en XML?

Los atributos se utilizan para distinguir entre elementos del mismo nombre. Cuando no se desea crear un nuevo elemento de cada situación. Por lo tanto, el uso de un atributo puede agregar un poco más en detalle a la hora de diferenciar dos o más elementos similares.

¿Cómo resolver un comentario en Word?

Podrá responder a los comentarios de la siguiente manera: en Word 2019, toque el cuadro del comentario que desee responder y aparecerá la opción Responder;en Word 2016, elija el comentario que desee responder, luego el globo de Respuesta y escriba su respuesta, o bien, con el botón secundario seleccione Responder al ...

¿Cómo responder a los comentarios en Word?

Si ya está editando el documento (Editar documento > Editar en Word Web App), haga clic en revisar > Mostrar comentarios.
  1. En el panel comentarios , haga clic en el comentario al que desea responder.
  2. Haga clic en el icono de respuesta situado debajo de él.

¿Cómo hacer un comentario en documentos digitales?

Agregar o ver comentarios
  1. Para agregar un nuevo comentario en la Vista de lectura, seleccione el texto al que desea agregar un comentario y, a continuación, haga clic en Comentarios > Nuevo comentario.
  2. Para ver los comentarios en la Vista de edición, haga clic en Revisar > Comentarios.

Articolo precedente
¿Cuál fue el objetivo de la Batalla de La Tablada?
Articolo successivo
¿Cuál es la mejor edad para perder la virginidad?