Uses espree to extract JavaScript code comments from a string. Returns an array of comment objects, with line, column, index, comment type and comment string.
npm install espree-extract-comments> Uses espree to extract JavaScript code comments from a string. Returns an array of comment objects, with line, column, index, comment type and comment string.
- Install
- API
- Example results
- Related projects
- Running tests
- Contributing
- Author
- License
_(TOC generated by verb using markdown-toc)_
Install with npm:
``sh`
$ npm i espree-extract-comments --save
Params
* string {String}options
* {Object}: Options to pass to espree.returns
* {Object}: Object of code comments.
Example
`js`
var extract = require('espree-extract-comments');
extract('// this is a code comment');
See fixtures/app.js to see the code comments used to generate the following:
`jsoptions
[{ type: 'Block',
value: '\n Create an instance of App with .\n \n @param {Object} options\n * @api public\n ',`
range: [ 15, 112 ],
loc: {
start: { line: 3, column: 0 },
end: { line: 8, column: 3 } }
}]
* esprima-extract-comments: Extract code comments from string or from a glob of files using esprima. | homepage
* extract-comments: Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… more | homepage
* js-comments: Parse JavaScript code comments and generate API documentation. | homepage
* parse-comments: Parse code comments from JavaScript or any language that uses the same format. | homepage
Install dev dependencies:
`sh``
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb on December 30, 2015._