Comment Code with JS Doc

[danpastori]

Problem

Code needs JSDoc comments for easy reading and documentation

Rationale

Utilizing JSDoc makes it easier to bring other developers on board and keeps a standard for documenting code. This will help other contributors pick up the code and dive right in. It also provides a baseline for how other contributors comment their features. The standard is here: http://usejsdoc.org/

Solution

I will go through the existing Shr code, and comment all of the features and methods using JSDoc.

Pros of Solution:

• Code gets commented and easy for contributors to pick up.

Cons of Solution

• Can take a little time to get used to the standards

Let me know if JSDoc is something you are interested in and I'll get it added and submit a PR

[sampotts]

Sounds great to me! I've started using it some other JavaScript libs and it makes total sense. 👍