Questions And Answers

More Tutorials

Dart Documentation using Dartdoc

Using a doc comment instead of a regular comment enables dartdoc to find it and generate documentation for it.

/// The number of characters in this chunk when unsplit.
int get length => ...

You are allowed to use most markdown formatting in your doc comments and dartdoc will process it accordingly using the markdown package.

/// 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:
/// *
/// * [with the URL inline](
/// * [or separated out][ref link]
/// [ref link]:
/// # A Header
/// ## A subheader


In this page (written and validated by ) you learned about Dart Documentation using Dartdoc . What's Next? If you are interested in completing Dart tutorial, your next topic will be learning about: Dart Control Flow.

Incorrect info or code snippet? We take very seriously the accuracy of the information provided on our website. We also make sure to test all snippets and examples provided for each section. If you find any incorrect information, please send us an email about the issue:

Share On:

Mockstacks was launched to help beginners learn programming languages; the site is optimized with no Ads as, Ads might slow down the performance. We also don't track any personal information; we also don't collect any kind of data unless the user provided us a corrected information. Almost all examples have been tested. Tutorials, references, and examples are constantly reviewed to avoid errors, but we cannot warrant full correctness of all content. By using, you agree to have read and accepted our terms of use, cookies and privacy policy.