@param and @return

Learn @param and @return tags.

[name] instead of @param and @return

In Dart doc comments parameters are referenced with [name] brackets. The @param and @return tags from Java are not used in Dart.

Example: /// The [name] parameter is greeted. The returned value is a message. dartdoc turns [name] into a link to the parameter docs.

The return value is described in plain prose; no separate tag is needed. This gives more natural-sounding docs.

A [name] example

A typical doc comment: under /// [a] and [b] are summed. you add /// The result is an integer.

[a] and [b] link to the function parameters; the reader can click to jump to the definition. The return value is described in the second sentence.

This approach replaces the Java pair @param a ... @return ... with natural language.

Exercise A doc comment with [name]

Write int subtract(int a, int b) => a - b;. Add a doc comment above it: /// [b] is subtracted from [a].. In main call print(subtract(10, 4)).

Show example solution

/// [b] is subtracted from [a].
int subtract(int a, int b) => a - b;

void main() {
  print(subtract(10, 4));
}

Test yourself

How is a parameter referenced in Dart?
- @param name
- $name
- #{name}
- [name]
Show answer

[name] — [name] brackets link to the parameter.
Parameter reference

[name]

Parameter link
@param

Java tag
///

Doc comment
Plain prose

Return description

The [name] reference

/// ____ and [b] are added.

Show answer

/// [a] and [b] are added.

Next lesson: Example code

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies