Fatal编程技术网
  • javascript/
  • Javascript 如何在JSDoc中引用存储库？

Javascript 如何在JSDoc中引用存储库？

javascript documentation

Javascript 如何在JSDoc中引用存储库？,javascript,documentation,jsdoc,Javascript,Documentation,Jsdoc,我正在开发一个开源库，我使用它来编写文档。我想引用每个文件顶部的存储库 我可以使用@author将我的名字放在注释块中，但我不知道如何引用存储库。我猜是这样的： /** * @author John Doe<john@example.com> * @link https://github.com/john-example/my-repo */ /** *@作者约翰·多伊 *@linkhttps://github.com/john-example/my-repo */

我正在开发一个开源库，我使用它来编写文档。我想引用每个文件顶部的存储库

我可以使用
@author
将我的名字放在注释块中，但我不知道如何引用存储库。我猜是这样的：

/** 
 *  @author John Doe<john@example.com>
 *  @link https://github.com/john-example/my-repo
 */

/**
*@作者约翰·多伊
*@linkhttps://github.com/john-example/my-repo
*/
这样做对吗？或者我应该将
@链接
与
@参见

我的项目中的许多类都可以独立于库使用，因此有些用户可能只是复制他们需要的文件。这就是为什么在根文件夹中创建许可证文件是不够的，我想将存储库的链接放在每个文件的顶部。

试试
@请参见
使用
@link
，其中一个示例甚至是到Github的链接。将其放在文件的顶部：



阅读更多。我看了所有的文件，但没有找到更好的

虽然没有回答您的问题，但我可能会使用
@version
和
@链接来链接发布的URL