Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
Vue.js 2.x by Example

You're reading from   Vue.js 2.x by Example Example-driven guide to build web apps with Vue.js for beginners

Arrow left icon
Product type Paperback
Published in Dec 2017
Publisher Packt
ISBN-13 9781788293464
Length 412 pages
Edition 1st Edition
Languages
Tools
Arrow right icon
Author (1):
Arrow left icon
Mike Street Mike Street
Author Profile Icon Mike Street
Mike Street
Arrow right icon
View More author details
Toc

Table of Contents (13) Chapters Close

Preface 1. Getting Started with Vue.js 2. Displaying, Looping, Searching, and Filtering Data FREE CHAPTER 3. Optimizing your App and Using Components to Display Data 4. Getting a List of Files Using the Dropbox API 5. Navigating through the File Tree and Loading Folders from the URL 6. Caching the Current Folder Structure Using Vuex 7. Pre-Caching Other Folders and Files for Faster Navigation 8. Introducing Vue-Router and Loading URL-Based Components 9. Using Vue-Router Dynamic Routes to Load Data 10. Building an E-Commerce Store – Browsing Products 11. Building an E-Commerce Store – Adding a Checkout 12. Using Vue Dev Tools and Testing Your SPA

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
* @example <folder :f="entry" :cache="getFolderStructure"></folder>
*
* @param {object} f...
lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at €18.99/month. Cancel anytime