我对Javadoc很熟悉.在Javadoc中,您可以放置一个引用Javadoc的链接放在另一个类型上,如下所示:
/** * some java thingy. see this other java thingy too {@link OtherThingy} */ public class Thingy { /*...*/ } /** * some other java thingy. see the first java thingy too {@link Thingy} */ public class OtherThingy{ /*...*/ }
我可以在打字稿的JSDoc风格中做同样的事情吗?我知道我可以在评论中使用markdown,我可以放置网页链接,但这不是我想要的.
此外,任何对JSDoc/typescript文档工具的引用都会非常有用:)
编辑:根据下面的答案,这是JSDoc的一个功能,但似乎没有包含在VSCode中.VSCode中是否有有效的语法?
你确定可以,虽然你的里程可能会有所不同.
1:在Selenium-Webdriver的TypeScript输入文件中使用@link
2:关于JSDoc中@link的文档
链接破坏时链接内容:
1:在Selenium-Webdriver的TypeScript输入文件中使用@link
/**
* Converts a level name or value to a {@link logging.Level} value.
* If the name/value is not recognized, {@link logging.Level.ALL}
* will be returned.
* @param {(number|string)} nameOrValue The log level name, or value, to
* convert .
* @return {!logging.Level} The converted level.
*/
function getLevel(nameOrValue: string | number): Level;
2:关于JSDoc中@link的文档
以下示例显示了为{@link}标记提供链接文本的所有方法:提供链接文本
/** * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}. * Also, check out {@link http://www.google.com|Google} and * {@link https://github.com GitHub}. */ function myFunction() {}默认情况下,上面的示例生成类似于以下内容的输出:{@link}标记的输出
See MyClass and MyClass's foo property. Also, check out Google and GitHub.