Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert documentation to JSDoc #40

Open
olleharstedt opened this issue Mar 16, 2017 · 3 comments
Open

Convert documentation to JSDoc #40

olleharstedt opened this issue Mar 16, 2017 · 3 comments

Comments

@olleharstedt
Copy link

All functions should be documented using JSDoc conventions.

@Lukenickerson
Copy link
Member

Naive question: What's the benefit to using JSDoc?

@olleharstedt
Copy link
Author

  1. Using JSDoc conventions, each argument to functions would be document with @param. Return values would use @return. These conventions are used for PHPDoc and Java, too (and maybe other languages), making it easy to read and get an overview. It's especially useful for dynamically typed language, where the type of an argument might not be obvious (depending on naming conventions etc).
  2. JSDoc can generate documentation docs. Not sure if we need that.

@Lukenickerson
Copy link
Member

It's google approved (https://google.github.io/styleguide/jsguide.html#jsdoc); I think it's a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants