dart
Komentarze
Szukaj…
Składnia
- // Komentarz jednowierszowy
- / * Wielowierszowy / Komentarz w wierszu * /
- /// Komentarz Dartdoc
Uwagi
Dobrą praktyką jest dodawanie komentarzy do kodu w celu wyjaśnienia, dlaczego coś zostało zrobione lub wyjaśnienia, co coś robi. Pomaga to przyszłym czytelnikom Twojego kodu łatwiej zrozumieć kod.
Powiązane tematy nie na StackOverflow:
Komentarz na końcu linii
Wszystko po prawej stronie // w tym samym wierszu jest komentowane.
int i = 0; // Commented out text
Komentarz wieloliniowy
Wszystko pomiędzy /* i */ jest komentowane.
void main() {
for (int i = 0; i < 5; i++) {
/* This is commented, and
will not affect code */
print('hello ${i + 1}');
}
}
Dokumentacja za pomocą Dartdoc
Użycie komentarza do dokumentu zamiast zwykłego komentarza umożliwia dartdoc znalezienie go i wygenerowanie dokumentacji.
/// The number of characters in this chunk when unsplit.
int get length => ...
Masz prawo do korzystania przecen formatowania w twoich komentarzach DOC i dartdoc będzie je przetwarzać odpowiednio za pomocą pakietu markdown .
/// 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
Licencjonowany na podstawie CC BY-SA 3.0
Nie związany z Stack Overflow