https://github.com/walkmod/walkmod-comments-cleaner-plugin
Walkmod plugin to remove comments whose content is only code
https://github.com/walkmod/walkmod-comments-cleaner-plugin
Last synced: 5 months ago
JSON representation
Walkmod plugin to remove comments whose content is only code
- Host: GitHub
- URL: https://github.com/walkmod/walkmod-comments-cleaner-plugin
- Owner: walkmod
- Created: 2016-01-15T06:57:21.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-21T19:19:04.000Z (over 10 years ago)
- Last Synced: 2024-04-16T20:18:47.811Z (about 2 years ago)
- Language: Java
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.asciidoc
Awesome Lists containing this project
README
walkmod-comments-cleaner-plugin
================================
Raquel Pau
image:https://travis-ci.org/walkmod/walkmod-comments-cleaner-plugin.svg?branch=master["Build Status", link="https://travis-ci.org/walkmod/walkmod-comments-cleaner-plugin"]
This is a walkmod plugin to remove code that has been temporary commented but developer has forgotten to remove it.
== Example
Let's see an example. Take a look to this code.
```java
package example;
import java.util.*;
public class Foo{
public void goodBye(String s){
//System.out.println("bye +"s);
return "bye +"s;
}
}
```
What this plugins generates is the following modified code:
```java
package example;
public class Foo{
public void goodBye(String s){
return "bye +"s;
}
}
```
== Usage
Check that your walkmod version is at least 2.2.0. You can add walkmod-comments-cleaner-plugin via walkmod.
$walkmod add comments-cleaner
And then, to see the results
$ walkmod apply
Or, you can also check which would be the modified classes typing:
$ walkmod check
== Contributing
If you want to hack on this, fork it, improve it and send me a pull request.
To get started using it, just clone it and call mvn install.