如何在JSDoc中引用存储库？
演员
我正在开发一个开源库，并且我使用JSDoc作为文档。我想在每个文件的顶部引用存储库。
我可以使用来将我的名字放在注释栏中@author，但是我也不知道该如何引用存储库。我的猜测是：
/**
* @author John Doe<[email protected]>
* @link https://github.com/john-example/my-repo
*/
这是正确的方法吗？还是应该结合@link使用@see？
我项目中的许多类都可以独立于库使用，因此某些用户可能只复制他们需要的文件。这就是为什么在根文件夹中创建LICENSE文件还不够的原因，我想将存储库的链接放在每个文件的顶部。
格扎·克雷塞尼（Geza Kerecsenyi）
尝试@see使用@link，示例之一甚至是指向Github的链接。将其放在文件顶部：
在这里阅读更多。我浏览了所有文档，但没有发现更好的东西。
虽然本质上没有回答您的问题，但我可能会将其@version与@link发行版的URL一起使用。
本文收集自互联网，转载请注明来源。
如有侵权，请联系[email protected] 删除。
编辑于
相关文章
Related 相关文章
- 1
如何在 Git 中引用存储库的开头
- 2
如何在 Jenkins 中引用多个存储库？
- 3
如何引用github存储库中的文件
- 4
如何在paket.references中引用git存储库中的文件？
- 5
如何在Django模板中引用存储的数据库映像？
- 6
Django 如何在数据库中存储媒体文件（或图像）的引用
- 7
如何在数据库字段中存储多个图像引用
- 8
如何在Java中存储对类的引用？
- 9
如何在枚举中存储类引用？
- 10
如何在Haxe中引用JavaScript库
- 11
如何在NetBeans中引用库？
- 12
如何在存储库中搜索单词？
- 13
如何在化石中删除存储库？
- 14
如何在存储库中设置 flexform
- 15
如何引用git存储库？
- 16
如何在comments / JSDoc中引用另一种打字稿类型？
- 17
如何在自己的库中包含或引用库
- 18
Azure YAML 管道：如何在 Azure DevOps 中引用另一个项目中的项目和存储库
- 19
如何在单个事务中将图像上传到Firebase存储并将引用保存在数据库中？
- 20
如何在共享项目中从Maven本地存储库中获取一个Eclipse项目来引用源jar？
- 21
如何在服务器上正确存储图像并在数据库中引用它们？
- 22
如何在包含Git存储库的Git中存储目录？
- 23
如何在Rust中存储对结构的void *引用？
- 24
如何在std :: set中存储指向对象的指针（或引用）
- 25
如何在Go中存储对操作结果的引用？
- 26
如何在类中存储对 C 样式数组的引用？
- 27
如何在模板中存储右值或左值引用
- 28
如何在JSDoc中创建类别？
- 29
如何在JSDOC中记录对象数组
我来说两句