En todo lenguaje de programación los comentarios juegan un papel importante para una mejor comprensión del código en el futuro o por parte de cualquier otro programador. Los comentarios son un conjunto de declaraciones que no están destinadas a ser ejecutadas por el compilador. Proporcionan la documentación adecuada del código.
Tipos de comentarios de dardos:
- Comentario de una sola línea de dardo.
- Comentario multilínea de Dart.
- Comentario sobre la documentación de Dart.
1. Comentario de línea única Dart: el comentario de línea única Dart se utiliza para comentar una línea hasta que se produzca un salto de línea. Se hace usando una doble barra inclinada (//).
// This is a single line comment.
Ejemplo:
Dart
int main() { double area = 3.14 * 4 * 4; // It prints the area // of a circle of radius = 4 print(area); return 0; }
Producción:
50.24
2. Comentario multilínea de dardo: el comentario multilínea de dardo se utiliza para comentar una sección completa del código. Utiliza ‘/*’ y ‘*/’ para iniciar y finalizar un comentario de varias líneas, respectivamente.
/* These are multiple line of comments */
Ejemplo:
Dart
int main() { var lst = [1, 2, 3]; /* It prints the whole list at once */ print(lst); return 0; }
Producción:
[1, 2, 3]
3. Comentario de documentación de Dart: los comentarios de documentación de Dart son un tipo especial de comentario que se utiliza para proporcionar referencias a paquetes, software o proyectos. Dart admite dos tipos de comentarios de documentación “///” (estilo C#) y “/**…. .*/”(Estilo JavaDoc). Se prefiere usar «///» para los comentarios del documento tantas veces como * se usa para marcar los elementos de la lista en una lista con viñetas, lo que dificulta la lectura de los comentarios. Se recomiendan los comentarios de documentos para escribir API públicas.
/// This is /// a documentation /// comment
Ejemplo:
Dart
bool checkEven(n){ /// Returns true /// if n is even if(n%2==0) return true; /// Returns false if n is odd else return false; } int main() { int n = 43; print(checkEven(n)); return 0; }
Producción:
false