COMENTARIOS EN DART
Veremos los diferentes tipos de comentarios disponibles en Dart y como utilizarlos.
En Dart tenemos a nuestra disposición diferentes tipos de comentarios para documentar nuestro código.
Tipos de comentarios
- De código en línea
- De código en bloque
- De documentación
Los comentarios de código en línea se generan con los caracteres // seguido de tu comentario.
Los comentarios de código en formato bloque comienzan con el carácter /* y terminan con el carácter */.
Los comentarios de documentación se generan con los caracteres /// seguido de tu comentario para generar comentarios de documentación.
Para crear comentarios de documentación de bloque deben comenzar con /** y terminar con */.
Ejemplos de comentarios
Veamos algunos ejemplos de comentarios de código en formato línea o bloque.
Comentario de código en formato línea.
//Implementación más eficiente.
Comentario de código en formato bloque.
/*
* Modificamos el método htmlEscape en la versión 1.2
* Se ha realizado una modificación sobre los métodos de reemplazo
* para obtener una implementación más eficiente y segura.
*/
Comentario de documentación en formato línea.
/// Returns a Future that completes when the store is opened.
/// You must call this method before using
/// the store.
Comentario de documentación en formato bloque.
/**
* Encuentra la mejor implementación según este orden: IndexedDB, WebSQL, LocalStorage.
*/
No hay comentarios:
Publicar un comentario