在typedoc中标记/生成方法链接？

Question

我们应该使用哪种标记来标记某种东西是typedoc中的一种方法。例如，我有以下评论：

  /**
   * The index for all of the ValidationContext instances.
   * Not meant to be accessed directly.  Only decorators should
   * be modifying the state of the cache by using the addValidationContext() method.
   */

如何告诉typedoc addValidationContext是类中的方法？

Answer 1

您可以使用JSDoc {@link}或@see指令。

Answer 2

TypeDoc有两种设置链接的方法。对于方法和属性，您应该能够编写v-ons-page或v-ons-navigator并将其转换为链接。

如果您查看Renderer类的doc comment，则可以看到在api documentation site中渲染的示例。