# \_\_doc\_\_ (docstring)

[![Build Status](https://travis-ci.org/monolithed/__doc__.png)](https://travis-ci.org/monolithed/__doc__)
[![Dependency Status](https://gemnasium.com/monolithed/__doc__.png)](https://gemnasium.com/monolithed/__doc__)
[![Code Climate](https://codeclimate.com/repos/5294fd8356b1024752046244/badges/6ff4cf0a66daa819ebe8/gpa.png)](https://codeclimate.com/repos/5294fd8356b1024752046244/feed)
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/monolithed/__doc__/trend.png)](https://bitdeli.com/free "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:<br />
	* [PEP-0257] (http://www.python.org/dev/peps/pep-0257/)<br />
	* [Docstring] (http://en.wikipedia.org/wiki/Docstring)<br />
	* [Literate programming] (http://en.wikipedia.org/wiki/Literate_programming)<br />


### Synopsis

```js
Function.prototype.__doc__
```

### Installation

#####

```sh
npm install docstring
```

### Requirements

```
Object.defineProperty (ECMAScript 5)
```


### Usage

*Docstrings can be accessed by the \_\_doc\_\_ property on functions. <br />
The following JavaScript example shows the declaration of docstrings within a source file:*

```js

require('docstring');

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] (https://developers.google.com/closure/compiler/docs/js-for-compiler)
<br />
` /*! .. */ ` — [UglifyJS] (http://lisperator.net/uglifyjs/) 

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


### Testing

```
npm install
npm test
```


### 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 `npm test`
* Submit Pull Request once Tests are Passing

##

* The library is licensed under the MIT (LICENSE.txt) license
* Copyright (c) 2013 [Alexander Abashkin] (https://github.com/monolithed)