babel-extract-comments
Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.
Install
Install with npm:
Usage
Add to your Node.js/JavaScript project with the following line of code:
API
Extract code comments from the given string
.
Params
string
{String}: String of javascriptreturns
{Array}: Array of code comment objects.
Example
Extract code comments from a JavaScript file.
Params
file
{String}: Filepath to the file to parse.options
{Object}: Options to pass to esprima.returns
{Array}: Array of code comment objects.
Example
About
Related projects
You might also be interested in these projects:
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
Contributors
Commits | Contributor |
4 | |
1 |
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on February 12, 2018.
Last updated