I am working on an open source library, and I use JSDoc for documentation. I would like to reference the repository at the top of each file.
I am able to put my name in the comment block using @author, but I don't know how should I reference the repository as well. My guess is this:
/**
* @author John Doe<john@example.com>
* @link https://github.com/john-example/my-repo
*/
Is it the right way to do it? Or should I combine @link with @see?
Many of the classes in my project can be used independently from the library, so it is possible that some users will just copy the files they need. That is the reason, why creating a LICENSE file in the root folder is not enough, and I would like to put the link of the repository at the top of each file.
from How to reference the repository in JSDoc?
No comments:
Post a Comment