O'Reilly logo

Vue.js 2.x by Example by Mike Street

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

The complete code—with added documentation

With our app complete, we can now add some much-needed documentation. It's always good to document your code as this gives it reasoning and explanation. Good documentation should not just say what the code does, but why it does it, what is allowed, and what is not allowed.

A popular method for documentation is the JavaScript DocBlock standard. This set of conventions lays out style guide-like rules for you to follow when documenting your code. DocBlock is formatted in a comment block and features keywords starting with an @, such as @author, @example, or listing what parameters a function can accept with the @param keyword. An example would be:

/** * Displays a folder with a link and cache its contents ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required