dartdoc

Learn documentation generation with dartdoc.

dartdoc is Dart's official documentation generator. It reads the doc comments (///) in your source code and produces HTML documentation.

Command: dart doc (new name) or dartdoc (legacy). Output is written to the doc/api/ folder by default.

Writing a doc comment for every public API in a package is good practice; dartdoc gathers them automatically.

The dart doc command

The dart doc command scans the files under lib/, gathers the /// comments and produces HTML in the doc/api/ folder.

You can change the output location with --output: dart doc --output build/docs. This gives output suited to build systems.

Open the generated HTML in a browser to browse your package's API docs.

Write String greet(String name) => 'Hello $name';. Add a doc comment above it: /// Greets the name.. In main print print(greet('Alex')).

Show example solution

/// Greets the name.
String greet(String name) => 'Hello $name';

void main() {
  print(greet('Alex'));
}

The dart doc command

dart ____ --output build/docs

Show answer

dart doc --output build/docs

Next lesson: Doc comments