docstring

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

__doc__ (docstring)

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)

Function.prototype.__doc__
npm install docstring

or

git clone https://github.com/monolithed/__doc__.git
ECMAScript 5: Object.defineProperty

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 /*!

npm install
grunt minify
grunt test
grunt export

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

  • Fork the one
  • Create a topic branch
  • Make the commits
  • Write the tests and run grunt dev
  • Submit Pull Request once Tests are Passing
  • The library is licensed under the MIT (LICENSE.txt) license
  • Copyright (c) 2013 [Alexander Guinness] (https://github.com/monolithed)