dart
Comentarios
Buscar..
Sintaxis
- // Comentario de una sola línea
- / * Multi-línea / Comentario en línea * /
- /// comentario Dartdoc
Observaciones
Es una buena práctica agregar comentarios a su código para explicar por qué se hace algo o para explicar qué hace algo. Esto ayuda a los futuros lectores de su código a comprender más fácilmente su código.
Tema (s) relacionado (s) que no están en StackOverflow:
Comentario de fin de línea
Todo a la derecha de // en la misma línea está comentado.
int i = 0; // Commented out text
Comentario multilínea
Todo entre /* y */ está comentado.
void main() {
for (int i = 0; i < 5; i++) {
/* This is commented, and
will not affect code */
print('hello ${i + 1}');
}
}
Documentación utilizando Dartdoc.
El uso de un comentario doc en lugar de un comentario regular permite a dartdoc encontrarlo y generar documentación para él.
/// The number of characters in this chunk when unsplit.
int get length => ...
Se le permite utilizar la mayoría de rebajas formato en sus comentarios doc y dartdoc procesará en consecuencia utilizando el paquete de reducción del precio .
/// This is a paragraph of regular text.
///
/// This sentence has *two* _emphasized_ words (i.e. italics) and **two**
/// __strong__ ones (bold).
///
/// A blank line creates another separate paragraph. It has some `inline code`
/// delimited using backticks.
///
/// * Unordered lists.
/// * Look like ASCII bullet lists.
/// * You can also use `-` or `+`.
///
/// Links can be:
///
/// * http://www.just-a-bare-url.com
/// * [with the URL inline](http://google.com)
/// * [or separated out][ref link]
///
/// [ref link]: http://google.com
///
/// # A Header
///
/// ## A subheader
Modified text is an extract of the original Stack Overflow Documentation
Licenciado bajo CC BY-SA 3.0
No afiliado a Stack Overflow