如何在 JSDoc 中引用仓库？
How to reference the repository in JSDoc?
我正在开发一个开源库，我使用 JSDoc 作为文档。我想在每个文件的顶部引用存储库。
我可以使用 @author 将我的名字放在评论区，但我也不知道应该如何引用存储库。我的猜测是：
/**
* @author John Doe<john@example.com>
* @link https://github.com/john-example/my-repo
*/
这样做正确吗？或者我应该将 @link 与 @see 结合使用吗？
我项目中的很多类都可以脱离库独立使用，所以可能有些用户会直接复制他们需要的文件。这就是为什么在根文件夹中创建 LICENSE 文件是不够的，我想将存储库的 link 放在每个文件的顶部。
尝试 @see 和 @link，其中一个示例甚至是 link 到 Github。将其放在文件的顶部：
阅读更多 here。我浏览了所有文档，但没有找到更好的东西。
虽然我本身没有回答你的问题，但我可能会使用 @version 和 @link 到发布的 URL。
我正在开发一个开源库，我使用 JSDoc 作为文档。我想在每个文件的顶部引用存储库。
我可以使用 @author 将我的名字放在评论区，但我也不知道应该如何引用存储库。我的猜测是：
/**
* @author John Doe<john@example.com>
* @link https://github.com/john-example/my-repo
*/
这样做正确吗？或者我应该将 @link 与 @see 结合使用吗？
我项目中的很多类都可以脱离库独立使用，所以可能有些用户会直接复制他们需要的文件。这就是为什么在根文件夹中创建 LICENSE 文件是不够的，我想将存储库的 link 放在每个文件的顶部。
尝试 @see 和 @link，其中一个示例甚至是 link 到 Github。将其放在文件的顶部：
阅读更多 here。我浏览了所有文档，但没有找到更好的东西。
虽然我本身没有回答你的问题，但我可能会使用 @version 和 @link 到发布的 URL。