js-comments
Parse JavaScript code comments and generate API documentation.
Last updated 5 years ago by jonschlinkert .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install js-comments 
SYNC missed versions from official npm registry.

js-comments NPM version Build Status

Parse JavaScript code comments and generate API documentation.

Install with npm

$ npm i js-comments --save

Install with bower

$ bower install js-comments --save-dev

Table of Contents

(Table of contents generated by [verb])

Usage

var comments = require('js-comments');

Heads up!, only comments with @api public will be rendered!

API

.parse

Parse comments from the given str.

Params

  • str {String}: The string to parse.
  • options {Object}: Options to pass to [parse-comments]
  • returns {Array}: Array of comment objects.

Example

var fs = require('fs');
var str = fs.readFileSync('foo.js', 'utf8');
comments.parse(str, options);

.render

Process the given Lo-dash template string, passing a comments object as context.

Params

  • comments {Array}: Array of comment objects.
  • template {String}: The lo-dash template to use.
  • returns {String}

Example

comments.render(obj, options);

.renderFile

Write markdown API documentation to the given dest from the code comments in the given JavaScript src file.

Params

  • src {String}: Source file path.
  • dest {String}: Destination file path.
  • options {Object}
  • returns {String}: API documentation

Other awesome projects

  • code-context: Parse a string of javascript to determine the context for functions, variables and comments based… more
  • esprima-extract-comments: Extract code comments from string or from a glob of files using esprima.
  • extract-comments: Extract code comments from string or from a glob of files.
  • parse-code-context: Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype… more

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

Copyright © 2014-2015 Jon Schlinkert Originally modified from scrawl.js. Copyright (c) 2014 Caolan McMahon, contributors. Released under the MIT license.


This file was generated by verb-cli on May 29, 2015.

Current Tags

  • 0.5.4                                ...           latest (5 years ago)

35 Versions

  • 0.5.4                                ...           5 years ago
  • 0.5.3                                ...           5 years ago
  • 0.5.2                                ...           5 years ago
  • 0.5.1                                ...           5 years ago
  • 0.5.0                                ...           5 years ago
  • 0.4.2                                ...           5 years ago
  • 0.4.1                                ...           5 years ago
  • 0.4.0                                ...           5 years ago
  • 0.3.9                                ...           6 years ago
  • 0.3.8                                ...           6 years ago
  • 0.3.7                                ...           6 years ago
  • 0.3.6                                ...           6 years ago
  • 0.3.5                                ...           6 years ago
  • 0.3.4                                ...           6 years ago
  • 0.3.3                                ...           6 years ago
  • 0.3.2                                ...           6 years ago
  • 0.3.1                                ...           6 years ago
  • 0.3.0                                ...           6 years ago
  • 0.2.5                                ...           6 years ago
  • 0.2.4                                ...           6 years ago
  • 0.2.3                                ...           6 years ago
  • 0.2.2                                ...           6 years ago
  • 0.2.1                                ...           6 years ago
  • 0.2.0                                ...           6 years ago
  • 0.1.10                                ...           6 years ago
  • 0.1.9                                ...           6 years ago
  • 0.1.8                                ...           6 years ago
  • 0.1.7                                ...           6 years ago
  • 0.1.6                                ...           6 years ago
  • 0.1.5                                ...           6 years ago
  • 0.1.4                                ...           6 years ago
  • 0.1.3                                ...           6 years ago
  • 0.1.2                                ...           6 years ago
  • 0.1.1                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 765
Last Day 2
Last Week 375
Last Month 597
Dependencies (7)
Dev Dependencies (3)

Copyright 2014 - 2016 © taobao.org |