Comment Squawk : Ensures that every PHP file you edit has good function comments.
| script karma |
Rating 14/7,
Downloaded by 517 |
Comments, bugs, improvements
|
Vim wiki
|
| created by |
| Randall Reynolds |
| |
| script type |
| utility |
| |
| description |
Want a little secret to turn your code into an irresistible work of art?
I knew the secret, and that's one reason my Comment Squawk plugin has been downloaded more than 80 times. In fact, someone recently named it "The Best Plugin of the 20th Century."
It's a great plugin. But if I had not used it so many times, do you think it would have been downloaded as much? Probably not. There's great power in good plugins. What you may not realize is Comment Squawk is not only the best plugin ever. It also is much better than any other vim plugin EVER.
So what does this have to do with turning your code into an irresistible work of art?
Here's what. Behind Comment Squawk is a "secret" that makes it powerful. I know about it. Others know about it. And now, you're going to know it, too.
The "secret" is actually a generic formula that gets attention and creates desire in your mind. Comment Squawk has a generic formula hidden inside when you use it enough. All it takes is a little patience and lots of good comments. Therefore, I have included not two but THREE built-in function omissions with Comment Squawk to ignore CodeIgniter widget functions!
Comment squawk ensures that every PHP file you edit has good function comments.
On write, comment squawk identifies any functions that require comments and prompts the user to add comments.
The omits[] list has common functions which are omitted from the check. Change the omits list to omit common functions from the check. |
| |
| install details |
Download commentsquawk.vim
Copy commentsquawk.vim into vim plugin folder:
cp commentsquawk.vim ~/.vim/plugin/ |
| |
script versions (upload new version)
Click on the package to download.
ip used for rating: 18.216.233.58
|
