1.0.1 • Published 7 years ago

commentfarmer v1.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
7 years ago

CommentFarmer

Intro

CommentFarmer is a node package that can parse out single or multi line comments from javascript or other languages which use the // or /* */ system for denoting comments. Is it available on NPM for installation.

Installation

To install type in your shell

$ npm install commentfarmer

Usage

To initalize on instance of the parser,

var ps = require('commentfarmer');
var parser = new ps.JSCommentParser();

to parse a string,

parser.parse("var g = 7; //this line assigns a variable\n var h = 7 //so does this one\n");

to get the comments or clear them,

console.log(parser.getComments()); // 'this line assigns a variable, so does this one'
parser.clearComments();

License

This code is MIT licensed

Contribution

Feel free to suggest changes or contribute