我正在开发一个开源库，我使用 JSDoc用于文档。我想在每个文件的顶部引用存储库。
我可以使用 @author 将我的名字放在评论 block 中，但我也不知道应该如何引用存储库。我的猜测是:
/**
* @author John Doe<john@example.com>
* @link https://github.com/john-example/my-repo
*/
这是正确的做法吗？或者我应该将 @link 与 @see 结合起来吗？
我的项目中的很多类都可以独立于库使用，所以可能有些用户会只复制他们需要的文件。这就是为什么在根文件夹中创建 LICENSE 文件是不够的，我想将存储库的链接放在每个文件的顶部。
最佳答案
尝试使用 @see 和 @link，其中一个示例甚至是 Github 的链接。把它放在文件的顶部:
阅读更多 here .我浏览了所有文档，但没有找到更好的内容。
虽然我本身没有回答您的问题，但我可能会使用 @version 和指向发布 URL 的 @link。
关于javascript - 如何在 JSDoc 中引用仓库？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/57347243/