在 typedoc 中标记/生成方法 link？

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 是 class 上的一个方法？

Answer 1

您可以使用 JSDoc {@link} or @see 说明。

Answer 2

TypeDoc 有两种设置 links 的方法。对于方法和属性，您应该能够编写 [[ClassName.methodName]] 或 {@link ClassName.methodName} 并将其转换为 link.

如果您查看 doc comment for the Renderer class you can see an example which is rendered in the api documentation site。