Как поместить Do c комментарии для параметров функции Dart?

Question

Мы можем легко поместить Do c комментарии для переменных класса Dart, например,

class SomeClass {
/// Class variable Doc Comment.
var someVariable;

}

Как я могу сделать то же самое для параметров функции Dart, например, я попробовал это

void someFunction(
 {/// Function parameter documentation
 String funParameter="Some Default Value"}
) {

}

Но это ничего не показывает. Если это невозможно, предложите мне любую альтернативу.

Answer 1

Вы должны использовать комментарий do c следующим образом:

/// the function uses [funParameter] to do stuff
void someFunction({String funParameter = "Some Default Value"}) {
    // ..
}

Answer 2

Это против соглашений Действующего дротика для документирования параметров функций с использованием прямого синтаксиса, подобного этому. Вместо этого используйте prose для описания параметра и его отношения к назначению функции.

// Instead of this

/// someFunction
/// @funParameter Does something fun
void someFunction({ String funParameter="Some Default Value" }) ...

// Or this

/// someFunction
void someFunction({
  /// Does something fun
  String funParameter="Some Default Value" 
}) ...

// Do this

/// Does something fun with the [funParameter].
void someFunction({ String funParameter="Some Default Value" }) ...

Вот, пожалуй, более практичный пример:

/// Takes the values [a] and [b] and returns their sum. Optionally a
/// third parameter [c] can be provided and it will be added to the 
/// sum as well.
int add(int a, int b, [int c = 0]) ...