如何在dartdoc中引用构造函数和运算符?
文件中包含了文档注释,并说明: 在文档注释中,Dart编译器忽略所有文本,除非 在括号内。使用括号,可以引用类、方法、, 字段、顶级变量、函数和参数。括号内的姓名 在文档化程序元素的词法范围内解析 我可能希望能够引用范围中的任何内容,但我在解决如何引用命名和未命名构造函数以及运算符方面遇到了困难 我创建了一个带有文档注释的测试库:如何在dartdoc中引用构造函数和运算符?,dart,Dart,文件中包含了文档注释,并说明: 在文档注释中,Dart编译器忽略所有文本,除非 在括号内。使用括号,可以引用类、方法、, 字段、顶级变量、函数和参数。括号内的姓名 在文档化程序元素的词法范围内解析 我可能希望能够引用范围中的任何内容,但我在解决如何引用命名和未命名构造函数以及运算符方面遇到了困难 我创建了一个带有文档注释的测试库: /// # Thingy /// /// Blah [GLOBAL] blah [function] blah [Thingy] blah [Thingy.prop
/// # 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生成的库、类和方法文档如下所示:
废话废话
废话named
废话operator+
试试这些:Thingy.named
blahThingy。(
blahThingy()
)
(不是实际的Dartdoc输出-只是它的外观。用于模拟链接的Dart语言教程URL。)
大多数引用都有效,但我如何引用构造函数和运算符呢?使用
new
/// [new MyClass]
/// [new MyClass.someNamedConstructor]
我还没有找到引用运算符的方法
/// [operator ==] or [==] seem not to work
我创建了文件和dart文件注释,包括参考资料。是的,这些都有效。谢谢你能告诉我哪里有记录吗?关于如何引用操作员实现的任何线索?我不知道这是在哪里记录的。我会尽力弄清楚的。我想我在bug报告或其他讨论中看到了它。此外,由于Dartdoc团队在回应Günter的bug报告时指出了这一点,构造器的克隆化也以这种方式工作(不确定是否完全可用);是的,我有点不好意思,我在这里问之前没有找到。