javascript - 在 typedoc 中标记/生成方法链接?

标签 javascript typescript jsdoc typedoc

我们应该使用什么标记来标记某物是 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 是类中的一个方法?

最佳答案

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

如果您查看 doc comment对于 Renderer 类,您可以看到在 api documentation site 中呈现的示例.

关于javascript - 在 typedoc 中标记/生成方法链接?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/51088278/

相关文章:

java - jqplot条形图的多维数组

javascript - Android、WebView 和 SpeechRecognition-API

javascript - 如何在 Vue 类组件中定义过滤器?

javascript - 类型错误:generateKeyPairSync 不是函数

javascript - WebStorm对函数返回类型的类型识别的困惑

javascript - 使用 JSDoc 我将如何注释一个解构的重命名函数参数?

javascript - Node JS Mocha 测试用例未运行

javascript - 将值从 mergeLatest 映射到 Array

angular - 重复声明 TypeScript Getter Setter

jsdoc - 如何用 jsdoc 描述 js 模块