Рассмотрим следующий пример (распространенный, если вы используете пакет поставщика Flutter): у вас есть класс с частной переменной, доступ к которой можно получить через сеттер и геттер. Каково соглашение/рекомендуемый способ документирования этого?
class Foo extends ChangeNotifier {
int _bar = 0;
int get bar => bar;
set bar(int bar){
_bar = bar;
notifyListeners();
}
}
Должны ли вы добавлять комментарии как к сеттеру, так и к геттеру и объяснять назначение переменной в обоих комментариях, или вы должны просто добавить комментарий к приватной переменной?
Например:
class Foo extends ChangeNotifier {
/// The number of bars in the foo.
int _bar = 0;
/// Get the number of bars in the foo.
int get bar => bar;
/// Set the number of bars in the foo.
set bar(int bar){
_bar = bar;
notifyListeners();
}
}
vs.
class Foo extends ChangeNotifier {
/// The number of bars in the foo.
int _bar = 0;
int get bar => _bar;
set bar(int bar){
_bar = bar;
notifyListeners();
}
}
Первый пример наиболее нагляден, но он может означать много повторяющихся комментариев. Второй пример уменьшает количество комментариев, но не так легко увидеть, что делает геттер/сеттер (например, наведя на него курсор в коде vs). Есть ли рекомендации команды Dart или соглашение о том, как должна быть написана документация в подобных случаях?
set
, так и дляget
для данного свойства. Примером может служитьlength
наList
: api.dart. dev/stable/2.13.0/dart-core/List/length.html - person julemand101   schedule 15.05.2021//
? - person Hannes Hultergård   schedule 15.05.2021