我们应该使用什么标记来标记某物是 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/