https://github.com/vijaysutrave/commentify

Add comments to your code, with one npm command!
https://github.com/vijaysutrave/commentify

Last synced: 1 day ago
JSON representation

Add comments to your code, with one npm command!

• Host: GitHub
• URL: https://github.com/vijaysutrave/commentify
• Owner: vijaysutrave
• Created: 2016-10-02T16:25:03.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-04T06:41:49.000Z (over 8 years ago)
• Last Synced: 2024-10-30T00:54:30.558Z (2 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/commentify
• Size: 12.7 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#### commentify

![Easily documentation comments to your code](https://www.dropbox.com/s/7zg2rjmyrog6nq6/comment.jpg?raw=1)

Add documentation comments to your code, with one npm command! 

Everybody likes to read well documented code. 

It's easier for a newbie to understand what's going on. 

Gives your peer an understanding of what you're really trying to do.

This package, adds comments to all functions like a pattern specified in [jsDoc](http://usejsdoc.org/about-getting-started.html#adding-documentation-comments-to-your-code). 

Just add in your custom function description to the comment pattern, and you're awesome!

#### Install

`npm install -g commentify`

#### Usage

Run `commentify` in any directory. 

The prompt will check if you want to comment a file, or all files in a directory. 

If file, do not enter the `.js` extension at the end of file. Also, give in a relative path from the current directory. 

#### License

MIT © [vijaysutrave](https://github.com/vijaysutrave)