En codificación, los comentarios son una de las pocas formas de preservar pensamientos para el futuro. Pueden ayudarlo a pasar por alto los fragmentos de código y pueden ser útiles para el próximo desarrollador que intentará comprender lo que escribió días antes. Si está utilizando Visual Studio Code (VS Code), no es necesario escribir incansablemente delimitadores de comentarios cada vez. VS Code tiene una función de acceso directo incorporada que le ahorra segundos (e incluso minutos) de su tiempo.
El atajo de comentario de Quick VS Code
Para aquellos que tienen prisa, aquí está su billete dorado:
cómo hacer una captura de pantalla en Snapchat sin que ellos sepan iPhone
- Para un comentario de una sola línea, use la combinación de teclas Ctrl + / en Windows o Linux o Cmd + / en Mac.
,
- Para un comentario de bloque, use Shift + Alt + A en Windows o Linux o Shift + Opción + A en una Mac.
,
- Para comentar el código, puede presionar Ctrl + K + C en Windows o Cmd + K + U en Mac.
,
La mayoría de los programadores comentan mucho. Y no se trata sólo de dejar comentarios reales, sino que quizás lo más importante sea que comentarás y descomentarás el código. Esto es viable para probar, experimentar y depurar.
Existen atajos para hacer esto más aceptable. Aceleran la navegación y la modificación, permitiéndole alternar comentarios sin interrumpir el impulso de la codificación.
Comentar más allá de lo básico
Si bien los atajos básicos son un verdadero regalo, hay mucho más que comentar en VS Code. Profundicemos más:
Alternar comentarios
La mejor parte de los atajos de comentarios de VS Code es su función de alternancia. No es necesario que juegues y elimines cada marcador de comentario manualmente si cambias de opinión (o durante la depuración). En su lugar, simplemente usa los mismos atajos. Con las mismas combinaciones de teclas, puedes cambiar rápidamente entre código comentado y no comentado para mantenerte organizado cuando más lo necesitas.
Comentar varias líneas
Si necesita silenciar un bloque de código extenso o dejar un comentario extenso y detallado, no querrá perder tiempo agregando comentarios línea por línea. Entonces, en su lugar, puede seleccionar las líneas que desea desactivar y usar el acceso directo a comentarios para permitir que VS Code inserte comentarios en cada línea.
Comentarios anidados
A veces, insertar comentarios en un bloque de código puede generar resultados inesperados y errores si los delimitadores no coinciden muy bien. Aquí es donde Intellisense de Visual Studio Code puede ayudarle. Ajustará el formato de los comentarios incluso dentro de un bloque ya comentado, por lo que no habrá conflictos con los comentarios anidados.
Extensiones para sobrecargar comentarios
VS Code es un editor de código abierto que sirve como plataforma para que los desarrolladores realicen su mejor trabajo de extensión. El mercado está repleto de extensiones para brindarte más poder y utilidad al comentar:
Mejores comentarios
Los comentarios pueden parecer una parte pequeña y opcional de la codificación, pero hay muchas formas creativas de utilizar los comentarios. El Mejores comentarios La extensión le ayuda a agregar propósito y claridad a los comentarios que publica al categorizarlos en alertas, consultas, TODO y otras categorías. Y todo ello con la ventaja añadida de la codificación por colores para mejorar la visibilidad y la organización. Sus comentarios se convierten en puntos de guía y separadores que hacen que su código sea más claro y accesible.
Anclas de comentarios
Anclas de comentarios lo mantendrá conectado a su código con puntos que distinguen secciones o puntos esenciales dentro. Si prueba esta extensión, le permitirá encontrar rápidamente notas y comentarios precisos. Si su proyecto es enorme y su código se vuelve saturado y difícil de seguir, esto podría hacerlo mucho más digerible.
Polacode
Polacode transforma su código y comentarios en imágenes visualmente interesantes, fácilmente legibles y compartibles que son perfectas para las redes sociales. Le permite cambiar el tamaño, codificar colores, cambiar el fondo y más. Usted se beneficia de una mayor legibilidad y cualquier compañero de equipo puede colaborar y compartir conocimientos mucho más fácilmente.
¿Por qué comentar?
Comentar no es sólo una casilla para marcar o una tarea opcional que realizan las personas prolijas; es una parte integral de la codificación. Estas son algunas de las razones para ello:
cómo bloquear sitios en iphone
Claridad
Los codificadores buscan hacer inteligible lo intratable. Escribir código que funcione a veces puede ser más sencillo que escribir código que sea fácil de entender y seguir. Los comentarios son la brújula de un desarrollador: una ayuda invaluable para navegar por extensiones de código, ya sean ligeros y jóvenes o densos y maduros. Es posible que esté lidiando con algoritmos complicados o procesos comerciales arcanos. En cualquier caso, los comentarios proporcionan un asidero familiar en un mar de complejidad.
Colaboración
Los comentarios son útiles cuando eres un desarrollador en solitario. Pero son necesarios cuando se trabaja en equipo si desea que su proyecto avance. Dentro de un esfuerzo de colaboración, los comentarios permiten que varios desarrolladores trabajen juntos sin problemas incluso cuando no interactúan. Los miembros del equipo pueden explicar el código y compartir sus procesos de pensamiento y el razonamiento detrás de sus decisiones. Esto sirve como un puente que permite que todos estén en sintonía tanto con el proyecto como entre sí.
Depuración
Si te encuentras revisando código antiguo o intentando depurar algo que te desconcierta, los comentarios se convierten en tu salvación. Mantienen un registro de su lógica pasada y su proceso de pensamiento que puede indicarle la posible lógica defectuosa y llevarlo de regreso a los orígenes del error. Con este recordatorio de dónde estuvo en el pasado, puede revertir cambios problemáticos, optimizar el código anterior y volver a la normalidad.
Consejos para realizar comentarios eficaces
Ahora ya sabe cómo utilizar los atajos de comentarios, tiene algunas extensiones adicionales convenientes y comprende escenarios en los que comentar es más útil. Todo lo que le queda es considerar algunas de las mejores prácticas de comentarios y se habrá graduado del curso de codificación de comentarios.
Sé conciso
Hay un arte en dejar comentarios concisos y fácilmente digeribles. Deje lo suficiente para darle a su yo futuro o a los miembros de su equipo la idea correcta, pero no tanto como para resultar abrumador. Cada palabra de tu comentario debe tener un propósito y ayudar a desarrollar el mensaje que intentas transmitir. Si su comentario es demasiado breve, es posible que no transmita su mensaje, pero si es demasiado largo, es más probable que lo pase por alto o se confunda en el futuro.
Evite comentarios obvios
La relevancia debe ser su principal preocupación a la hora de crear un código claro y comprensible. Si ya escribe su código de manera que su significado sea obvio, no es necesario mencionar algo que se pueda ver a primera vista. Deje que el código hable siempre que pueda y utilice comentarios para agregar contexto adicional o proporcionar nuevas perspectivas.
Utilice comentarios para 'por qué', no para 'qué'
Su código establece los hechos de lo que está sucediendo. Pero los comentarios pueden contar una historia más profunda. Transmiten las motivaciones y los procesos de pensamiento detrás de sus decisiones. ¿Por qué elegiste este algoritmo en lugar de otro? ¿Cuáles fueron los obstáculos a tener en cuenta? Quizás probaste algún código que muchos recomendarían, pero no funcionó o no funcionó bien. Puedes transmitir mucho más que meras instrucciones con comentarios bien elaborados.
Dejando un comentario
La función de comentarios de VS Code podría ser más que una conveniencia. Si lo aprovecha al máximo, la diferencia en la navegabilidad y comprensibilidad de su código base puede ser enorme. Complementado con extensiones inteligentes y una estrategia exhaustiva, pronto podrá crear un código bien documentado que se lea como una obra maestra.
¿Dejas muchos comentarios para explicar tu código? ¿O utiliza principalmente comentarios para excluir código experimental o roto del depurador? Cuéntanos tu historia en los comentarios a continuación. Están aquí para quedarse.
