Book Image

Learning JavaScriptMVC

By : Wojciech Bednarski
Book Image

Learning JavaScriptMVC

By: Wojciech Bednarski

Overview of this book

<p>JavaScriptMVC is a client-side, JavaScript framework that builds maintainable, error-free, lightweight applications as quickly as possible. As it does not depend on server components, it can be combined with any web service interface and server-side language.<br /><br />"Learning JavaScriptMVC" will guide you through all the framework aspects and show you how to build small- to mid-size well-structured and documented client-side applications you will love to work on.<br /><br />This book starts from JavaScriptMVC installation and all its components are explained with practical examples. It finishes with an example of building a web application. You will learn what the JavaScriptMVC framework is, how to install it, and how to use it efficiently.<br /><br />This book will guide you on how to build a sample application from scratch, test its codebase using unit testing, as well as test the whole application using functional testing, document it, and deploy the same. After reading Learning JavaScriptMVC you will learn how to install the framework and create a well-structured, documented and maintainable client-side application.</p>
Table of Contents (13 chapters)

Chapter 2. DocumentJS

Source code alone is insufficient; documentation is an important part of software engineering. DocumentJS is a powerful, yet simple tool designed to easily create searchable documentation for any JavaScript codebase.

In this chapter, we will to get an overview of DocumentJS. We will learn how it works and learn to generate its documentation.

The following are the key features of DocumentJS:

  • Flexible and easy to extend

  • Support Markdown: http://en.wikipedia.org/wiki/Markdown

  • Integrated documentation viewer with API search

  • Works with any JavaScript code and not only with JavaScriptMVC

If you are familiar with JSDoc, YUIDoc, YARD, or similar documentation syntax/tools in then DocumentJS can be learned a, few minutes.

The documentation for DocumentJS can be found at http://javascriptmvc.com/docs.html#!DocumentJS.

Note

Markdown is a text-to-HTML conversion tool that allows you to write using an easy-to-read and easy-to-write plain text format (http://daringfireball.net/projects/markdown...