codernaut / commentremover

Source Code Comment Remover For Java

CommentRemover

CommentRemover is a source code comment removing library for Java™ 7 and above.

It also supports JavaScript , HTML , CSS , Properties , JSP and XML Comments.

CommentRemover does not depend on any libraries, you can easily add it as standalone .jar to your classpath.

Requirements

Projects that include CommentRemover need to target Java 1.7 at minimum.

Please increase your stack size to 40m.
VM option command is: -Xss40m if you need to increase more -Xss{size}m

Installation

##Maven In your pom.xml, you must add Repository and Dependency for CommentRemover.

After adding dependency run mvn clean install command and make sure that maven clean and install processes are completed.

	<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
	
	<dependency>
    	    <groupId>com.github.ertugrulcetin</groupId>
    	    <artifactId>CommentRemover</artifactId>
    	    <version>1.2</version>
    </dependency>
    	

##Gradle In your gradle file, you must add Repository and Dependency for CommentRemover.

    repositories {
    	    maven {
    	        url "https://jitpack.io"
    	    }
    	}    
   

     dependencies {
	        compile 'com.github.ertugrulcetin:CommentRemover:1.2'
	   }
   

Usage

public class InternalPathExample {
    
 public static void main(String[] args) throws CommentRemoverException {
        
 // root dir is: /Users/user/Projects/MyProject
 // example for startInternalPath
    
 CommentRemover commentRemover = new CommentRemover.CommentRemoverBuilder()
        .removeJava(true) // Remove Java file Comments....
        .removeJavaScript(true) // Remove JavaScript file Comments....
        .removeJSP(true) // etc.. goes like that
        .removeTodos(false) //  Do Not Touch Todos (leave them alone)
        .removeSingleLines(true) // Remove single line type comments
        .removeMultiLines(true) // Remove multiple type comments
        .preserveJavaClassHeaders(true) // Preserves class header comment
        .preserveCopyRightHeaders(true) // Preserves copyright comment
        .startInternalPath("src.main.app") // Starts from {rootDir}/src/main/app , leave it empty string when you want to start from root dir
        .setExcludePackages(new String[]{"src.main.java.app.pattern"}) // Refers to {rootDir}/src/main/java/app/pattern and skips this directory
        .build();
        
 CommentProcessor commentProcessor = new CommentProcessor(commentRemover);
                  commentProcessor.start();        
  }
}

public class ExternalPathExample {
    
 public static void main(String[] args) throws CommentRemoverException {

 // example for externalInternalPath
    
 CommentRemover commentRemover = new CommentRemover.CommentRemoverBuilder()
        .removeJava(true) // Remove Java file Comments....
        .removeJavaScript(true) // Remove JavaScript file Comments....
        .removeJSP(true) // etc..
        .removeTodos(true) // Remove todos
        .removeSingleLines(false) // Do not remove single line type comments
        .removeMultiLines(true) // Remove multiple type comments
        .preserveJavaClassHeaders(true) // Preserves class header comment
        .preserveCopyRightHeaders(true) // Preserves copyright comment
        .startExternalPath("/Users/user/Projects/MyOtherProject")// Give it full path for external directories
        .setExcludePackages(new String[]{"src.main.java.model"}) // Refers to /Users/user/Projects/MyOtherProject/src/main/java/model and skips this directory.
        .build();
        
 CommentProcessor commentProcessor = new CommentProcessor(commentRemover);
                  commentProcessor.start();        
  }
}

License

  Copyright 2016 Ertuğrul Çetin
  
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
  http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.