docstrings

docstrings in javascript


Keywords
docstring, doc, docs, docstrings, documentation, clojure
License
ISC
Install
npm install docstrings@0.2.1

Documentation

docstrings

Interpret a string literal at the beginning of a function as its documentation.

Usage

var doc = require('docstrings')

function foo () {
  "returns foo"
  return 'foo'
}

console.log(doc(foo))

This will output

returns foo

API

var doc = require('docstrings')

doc(func)

Returns a string matching the string literal at the beginning of a function. Matches "" and '' literals as well as template strings.

Install

With npm installed, run

$ npm install docstrings

Acknowledgments

docstrings was inspired by clojure's approach to documenting functions.

License

ISC