Markdown

Learn documentation formatting with Markdown.

Markdown

Doc comments support Markdown. Headings use #, bold **, italics * and code blocks ```.

dartdoc converts them to HTML. Example: ## Heading, **important**, `code`. This makes documentation rich and readable.

Use - dashes for lists and single backticks for inline code. Format sparingly, not excessively.

A Markdown example

Markdown inside a doc comment: first line /// # Calculation, a blank line, then /// This function does **fast** addition.

For a code example open a block with three backticks: /// ```dart ... /// ```. dartdoc renders it as syntax-highlighted HTML.

A blank /// line acts as a paragraph break; it improves readability.

Exercise A Markdown doc comment

Write int multiply(int a, int b) => a * b;. Add a doc comment above it: first line /// # Multiplication, second line /// **fast** operation.. In main call print(multiply(3, 4)).

Show example solution

/// # Multiplication
/// **fast** operation.
int multiply(int a, int b) => a * b;

void main() {
  print(multiply(3, 4));
}

Test yourself

Markdown formats

# Heading

Heading
**bold**

Bold
*italic*

Italic
`code`

Code
How is bold text marked in Markdown?
- {bold}
- <<bold>>
- **bold**
- //bold//
Show answer

**bold** — text wrapped in ** becomes bold.
Markdown heading
```
/// ____ Hesaplama
```
Show answer
```
/// # Hesaplama
```

Next lesson: @param and @return

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies