打字稿:文档注释中的安全重构符号参考

时间:2019-02-22 08:44:05

标签: typescript jsdoc

我正在寻找一种在文档注释中引用符号的方法:

/** A wrapper of @see {Foo}. */
class Bar {
  constructor(public readonly foo: Foo) {}
}

class Foo {}

但是,当我重命名Foo时,它不会重命名see引用。这种行为使我避免在文档注释中引用其他符号...

我知道有几个js-doc注释,其中一些实际上支持语义引用(例如@type@typedef@extends),但是它们具有特殊的语义,它们仅当它们开始时才被识别:

/**
* @type {Foo} The type. // does work
* See @type {Foo}. // does not work
*/

这不可能吗?

0 个答案:

没有答案