Summary - Documentation

Combine dartdoc, /// and Markdown to write a documented library.

Summary - Documentation

In this group you learned Dart documentation: dartdoc, /// doc comments, Markdown, [name] references and example code blocks.

Summary: dart doc produces HTML; /// writes a doc comment; Markdown adds rich formatting; [name] links parameters; ```dart shows example code.

Good docs need a short first sentence, correct parameter links and working example code; avoid over-formatting.

A combined example

A doc comment combining everything: under /// Multiplies the base by itself. add /// Returns the square of [base]. and optionally an example block.

Then the function: int power(int base) => base * base;. dartdoc builds a summary, parameter link and example from this comment.

Repeat this pattern for every public API in your package; it gives consistent docs.

Exercise A documented function

Write int power(int base) => base * base;. Add a two-line doc comment above it: first line /// Multiplies the base by itself., second line /// Returns the square of [base].. In main call print(power(6)).

Show example solution

/// Multiplies the base by itself.
/// Returns the square of [base].
int power(int base) => base * base;

void main() {
  print(power(6));
}

Test yourself

How is a parameter reference written in Dart?
- @param name
- [name]
- $name
- &name
Show answer

[name] — [name] brackets give a parameter link.
Documentation summary

dart doc

Produces HTML
///

Doc comment
[name]

Parameter
```dart

Code block
Example code block
```
/// ____dart
```
Show answer
```
/// ```dart
```

Next lesson: Project design

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies