Etiqueta tus comentarios, una función de desarrolladores para desarrolladores

Los comentarios son esenciales en la vida de un desarrollador. Cuando trabajamos en una nueva función, a menudo añadimos comentarios que son recordatorios. Por ejemplo:

• para validar una parte del código con un colega,
• para refactorizar una función,
• para arreglar el código que está ralentizando el rendimiento,
• para dividir un método o una clase en secciones,
• para preparar el esqueleto de una clase y añadir un comentario de todo dentro de cada función.

Incluso si escribes un código sencillo, intenta leerlo meses o años después. ¿Seguirá pareciendo sencillo, o deseará haber añadido comentarios?

4D v19 R4 lleva los comentarios a un nivel completamente nuevo con etiquetas de comentarios que le permiten organizar mejor sus comentarios.

Hay tres nuevas etiquetas a su disposición:

• MARCA
• TODO
• FIXME

En esta entrada anterior del blog, le mostramos una lista en el editor de código, que le permite navegar fácilmente dentro de su clase. Los comentarios precedidos por estas tres etiquetas también se muestran en esta lista.

Puedes usarlos dentro de tus clases o métodos.

Cómo utilizarlas

La etiqueta MARCA le permite dividir su código en secciones. Puedes escribirla de tres maneras diferentes. Las otras dos etiquetas TODO y FIXME, se escriben de la misma manera. La ventaja es que tienen diferentes iconos en la lista, lo que te permite organizar tu código para priorizar tus futuras acciones.

Aquí hay un ejemplo con una clase ORDA:

Las funciones y etiquetas de comentario se muestran en su orden de aparición dentro de la clase y el método. Si lo prefieres, puedes mostrar las funciones y etiquetas de comentario de una clase en orden alfabético manteniendo pulsado Cmd en macOS o Alt en Windows antes de desplegar el menú.

¿Qué es lo siguiente?

¿Estás listo para mejorar tu juego de codificación con esta nueva función? Cuéntanos qué te parece esta nueva posibilidad de organizar tu código y navegar en tus clases o métodos. Te esperamos en el foro.