node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


__doc__ (docstring)

Build Status Dependency Status Code Climate Bitdeli Badge

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] (
* [Docstring] (
* [Literate programming] (




npm install docstring


Object.defineProperty (ECMAScript 5)


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

Preserve directives

/** @preserve */ — [Google Closure Compiler] (
/*! .. */ — [UglifyJS] (

This annotation allows important notices (such as legal licenses or copyright text) to survive compilation unchanged. Line breaks are preserved


npm install
npm test

Inspired by

[PEP-0257] (


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

  • The library is licensed under the MIT (LICENSE.txt) license
  • Copyright (c) 2013 [Alexander Abashkin] (