docstring

__doc__ / docstring is a string literal specified in source code that is use like a comment, to document a specific segment of code

npm install docstring
2 downloads in the last day
3 downloads in the last week
36 downloads in the last month

__doc__ (docstring)

Build Status Dependency Status Code Climate Built with Grunt Bitdeli Badge Gittip

NPM

Docstring is a string literal specified in source code that is used, like a comment, to document a specific segment of code.

A docstring occurs as the first statement in a module, function, class, or method definition.

Languages that support docstrings include Python, Lisp, Elixir, and Clojure.

For more info see the following links:

* [PEP-0257] (http://www.python.org/dev/peps/pep-0257/)
* [Docstring] (http://en.wikipedia.org/wiki/Docstring)
* [Literate programming] (http://en.wikipedia.org/wiki/Literate_programming)

Synopsis

Function.prototype.__doc__

Installation

npm
npm install docstring

or

git
git clone https://github.com/monolithed/__doc__.git

Dependencies

ECMAScript 5: Object.defineProperty

Usage

Docstrings can be accessed by the __doc__ property on functions.
The following JavaScript example shows the declaration of docstrings within a source file:

var test = function ( data ) {
    /** @params {string} data */
};

console.log(test.__doc__);  // @params {string} data

The docstring have to start with /** or /*!

Deployment

npm install

Minification / Source Map

grunt minify

Testing

grunt test

Export

grunt export

Inspired by

[PEP-0257] (http://www.python.org/dev/peps/pep-0257/)

Contributing

  • Fork the one
  • Create a topic branch
  • Make the commits
  • Write the tests and run grunt dev
  • Submit Pull Request once Tests are Passing

#

npm loves you