Dart语言旅游涵盖文档注释,并指出:
在文档注释中,Dart编译器忽略所有文本,除非它被括在括号中。使用括号,您可以引用类、方法、字段、顶级变量、函数和参数.括号中的名称在文档化的程序元素的词法范围中解析。
我可能希望能够引用范围中的任何内容,但我很难找到如何引用命名和未命名的构造函数和操作符。
我创建了一个包含文档注释的测试库:
/// # Thingy
///
/// Blah [GLOBAL] blah [function] blah [Thingy] blah [Thingy.property] blah
/// [Thingy.virtualProperty] blah [Thingy.named] blah [Thingy.method]
/// blah [Thingy.operator+].
/// Try these: [Thingy.named()] blah [Thingy.()] blah [Thingy()].
library Thingy;
const int GLOBAL = 0;
void function(int arg) {}
/// A class.
///
/// Blah [GLOBAL] blah [function] blah [Thingy] blah [property] blah
/// [virtualProperty] blah [named] blah [method] blah [operator+].
/// Try these: [Thingy.named()] blah [Thingy.()] blah [Thingy()].
class Thingy {
int property;
int get virtualProperty => 0;
set virtualProperty(int arg) {}
Thingy(int arg) {}
Thingy.named(int arg) {}
/// A method.
///
/// Blah [GLOBAL] blah [function] blah [Thingy] blah [property] blah
/// [virtualProperty] blah [named] blah [method] blah [operator+] blah
/// [arg].
/// Try these: [Thingy.named()] blah [Thingy.()] blah [Thingy()].
void method(int arg) {}
Thingy operator+(int arg) => null;
}Dartdoc生成的库、类和方法文档如下所示:
全局,函数blah,物物,物物,属性,virtualProperty,
named,方法,operator+. 试试这些:Thingy.namedblahThingy.()Thingy()。
(不是实际的Dartdoc输出--就是它看起来的样子。)用于模拟链接的Dart语言旅游URL。)
大多数引用都可以工作,但是如何引用构造函数和操作符呢?
发布于 2016-01-20 21:56:15
构造函数与new一起引用
/// [new MyClass]
/// [new MyClass.someNamedConstructor]我还没有找到一种方法来引用运算符
/// [operator ==] or [==] seem not to work发布于 2016-01-23 20:18:54
有效文件:文件文档dart文档注释,包括引用。
发布于 2022-09-14 16:34:02
接受的答案已经过时了。
现在,要引用主要的未命名构造函数:
/// [MyClass.new]并引用命名构造函数:
/// [MyClass.someNamedConstructor]这个分析器消息解释了这一点。
https://stackoverflow.com/questions/34907717
复制相似问题