walkmod-comments-cleaner-plugin

Walkmod plugin to clean comments that are pure code

License

License

GroupId

GroupId

org.walkmod
ArtifactId

ArtifactId

walkmod-comments-cleaner-plugin
Last Version

Last Version

1.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

walkmod-comments-cleaner-plugin
Walkmod plugin to clean comments that are pure code
Project URL

Project URL

https://github.com/walkmod/walkmod-comments-cleaner-plugin
Source Code Management

Source Code Management

https://github.com/walkmod/walkmod-comments-cleaner-plugin

Download walkmod-comments-cleaner-plugin

How to add to project

<!-- https://jarcasting.com/artifacts/org.walkmod/walkmod-comments-cleaner-plugin/ -->
<dependency>
    <groupId>org.walkmod</groupId>
    <artifactId>walkmod-comments-cleaner-plugin</artifactId>
    <version>1.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.walkmod/walkmod-comments-cleaner-plugin/
implementation 'org.walkmod:walkmod-comments-cleaner-plugin:1.0.1'
// https://jarcasting.com/artifacts/org.walkmod/walkmod-comments-cleaner-plugin/
implementation ("org.walkmod:walkmod-comments-cleaner-plugin:1.0.1")
'org.walkmod:walkmod-comments-cleaner-plugin:jar:1.0.1'
<dependency org="org.walkmod" name="walkmod-comments-cleaner-plugin" rev="1.0.1">
  <artifact name="walkmod-comments-cleaner-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.walkmod', module='walkmod-comments-cleaner-plugin', version='1.0.1')
)
libraryDependencies += "org.walkmod" % "walkmod-comments-cleaner-plugin" % "1.0.1"
[org.walkmod/walkmod-comments-cleaner-plugin "1.0.1"]

Dependencies

compile (2)

Group / Artifact Type Version
org.walkmod : javalang-compiler jar [2.0, 3.0)
org.walkmod : walkmod-core jar [1.0.0,3.0.0)

test (3)

Group / Artifact Type Version
junit : junit jar 4.12
org.hamcrest : hamcrest-library jar 1.3
org.walkmod : walkmod-javalang-plugin jar [2.0, 3.0)

Project Modules

There are no modules declared in this project.

walkmod-comments-cleaner-plugin

Build Status

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.

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:

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.

org.walkmod

walkmod

Versions

Version
1.0.1
1.0.0