Comentarios en programación

Introducción al leguaje de programación

comentarios

Laura Sofia Rozo Natalia Moreno

introducción

Al momento de empezar a programar, la utilización de comentarios se convierte en una parte fundamental para mejorar la legibilidad de nuestro código; sin embargo, muchos desarrolladores desconocen el correcto uso de los mismos.

java

James Gosling

Bill Joy

Guy Steele

Objetivo

Rápido

Pequeño

Confiable

pilares

caracteristicas

usos

• Núcleo de lenguaje simple. (Basado en C y C++).
• Acceso y gestión de la memoria sencillo.
• Se ejecuta sobre una máquina hipotética o virtual, Java Virtual Machine (JVM), que se encarga de interpretar el código (ficheros compilados .class) y convertirlo a un código legible para la CPU.

• Variables locales, globales y de clase.
• Seguridad de tipo.

1. Desarrollo de videojuegos.
2. Desarrollo de páginas web.
3. • Procesamiento de datos.
4. •Inteligencia Artificial.
5. •Internet de las cosas.

¿Qué es un comentario?

Es una línea o bloque de texto que será ignorado por el compilador. Su único objetivo es proporcionar expliaciones, aclaraciones o notas sobre el código.

+info

Importancia de los comentarios

Los comentarios son fundamentales para los programadores debido a que: • Permite entender y explicar cómo funciona una parte específica del código. • Optimiza el mantenimiento y reutilización del programa. • Ahorra tiempo para el programador y futuros programadores. • Permite informar errores.

tipos de comentarios

Comentario de línea

Comentario de bloque

Comentario para documentación

EJEMPLOS

Marcar partes del código que necesitan ser revisadas, corregidas o mejoradas.

Explicar la intención del código.

Documentar funciones y métodos.

Evidenciar cambios

Información de derechos de autor.

Explicar algoritmos complejos.

BUENAS PRACTICAS

Comentar mientras se está codificando. Es preferible debido a que se tiene la idea clara del objetivo y funcionamiento del código.

Explicar el por qué/para qué junto al cómo funciona.

No es necesario comentar todas las líneas de código.

Comentar errores.

No llenar muchos comentarios con información de fechas y autores de cambios del programa

Organizar los comentarios de manera que sea legible para otra persona.

¿Qué es un entorno de desarrollo?

Un entorno de desarrollo (ED) es el conjunto de herramientas y recursos que el programador utiliza para escribir, depurar y ejecutar código de software. Por otro lado, un entorno de desarrollo integrado (IDE) es un paquete de software que combina todas las herramientas de desarrollo en una única interfaz gráfica de usuario..

ENTORNOS DE DESARROLLO

Sublime Text

Visual Studio Code

Atom

herramientas

Better Comments: Resalta los comentarios con colores diferentes.

TODO highlight o vscode-todo: Localiza los comentarios con la palabra TODO de forma que podamos saltar entre ellos y recordar lo que nos falta por hacer

Doxygen: Genera documentación a partir del código fuente

Javadoc: Especifico de Java, genera documentación a partir de comentarios en el código.

JAVADOC

COMENTARIO mÉTODOS

COMENTARIO CLASES

COMENTARIO VARIABLES

Conclusiones

Implementar el uso de comentarios significativos en el código es esencial ya que permiten proveer información importante acerca del objetivo, el funcionamiento y las limitaciones del mismo, además de facilitar su compresión y mantenimiento en futuras ocasiones.

¡GRACIAS!

Ejemplo de adición de comentarios en 15 lenguajes de programación https://geekflare.com/es/how-to-add-comments/

Utilización de redes. Hace referencia a la capacidad de Java para permitir a los desarrolladores crear programas que se comuniquen entre redes locales o más amplias como internet.

Utilización de programación orientada a objetos.

Ejecución del código remoto de manera segura.

Sencillo de programar.

Ejecución del programa en diferentes sistemas operativos. Bajo el paradigma WORA (Write Once Run Anywhere).