@label
标准化 | 核心 |
语法种类 | 内联标签 |
用法
{@label}
内联标签用于标记声明,以便可以使用 TSDoc 声明引用表示法中的选择器来引用它。
注意:
{@label}
标记尚未最终确定。请参阅 GitHub issue #9 issue #9
示例
export interface Interface {
/**
* Shortest name: {@link InterfaceL1.(:STRING_INDEXER)}
* Full name: {@link (InterfaceL1:interface).(:STRING_INDEXER)}
*
* {@label STRING_INDEXER}
*/
[key: string]: number;
/**
* Shortest name: {@link InterfaceL1.(:NUMBER_INDEXER)}
* Full name: {@link (InterfaceL1:interface).(:NUMBER_INDEXER)}
*
* {@label NUMBER_INDEXER}
*/
[key: number]: number;
/**
* Shortest name: {@link InterfaceL1.(:FUNCTOR)}
* Full name: {@link (InterfaceL1:interface).(:FUNCTOR)}
*
* {@label FUNCTOR}
*/
(source: string, subString: string): boolean;
/**
* Shortest name: {@link InterfaceL1.(:CONSTRUCTOR)}
* Full name: {@link (InterfaceL1:interface).(:CONSTRUCTOR)}
*
* {@label CONSTRUCTOR}
*/
new (hour: number, minute: number);
}