Project Icon

java-comment-preprocessor

多功能Java源代码预处理器 支持主流构建工具

java-comment-preprocessor是一款功能丰富的Java源代码预处理工具。它支持两阶段处理、文档结构解析、循环指令和XML数据源集成。该工具可通过命令行、Java库、Maven插件、ANT任务或Gradle任务方式使用。兼容Java 1.8及以上版本,提供多样化的预处理指令,适用于跨设备源代码管理、静态网站生成等场景。此外,它还具备注释清理和多段文档处理等高级特性。

Logo

License Apache 2.0 Maven central Java 1.8+ Maven 3.0+ Gradle 3.0+ Ant 1.8.2+ PayPal donation YooMoney donation

更新日志

7.1.2(2024年6月8日)

  • 添加了通过CLI(以"/EA:<class.name>"的形式)和插件(以"actionPreprocessorExtension"的形式)定义预处理器扩展类的方法。该类应在类路径中提供。#48
  • 更新了一些依赖项

7.1.1(2024年1月13日)

  • 修复了Maven和Gradle中空或null全局变量值导致的NPE问题 #47
  • 更新了依赖项

完整更新日志

简介

这个预处理器工具最初开发于2002年,源于高效管理J2ME设备多样化源代码的需求。它旨在简化不同设备间特定调用位置的更改过程,从而优化开发流程。以Java作为主要技术,该工具针对C/Java语言家族进行了微调,充分利用了它们的导入部分和C风格注释。

最初作为一个闭源项目,它于2011年转变为开源项目。如今,它已成为一个强大的两步式Java预处理器,能够理解文档结构(前缀、主体和后缀),包含循环,并将XML文件作为数据源。它的功能还扩展到生成静态网站。

预处理器现在作为一个综合的uber-jar存在,捆绑了Maven、ANT和Gradle的接口代码,与这些工具无缝集成。它需要至少1.8版本的JDK。

此外,各种Linux仓库都提供了名为libcomment-preprocessor-java的预处理器包,简化了用户的使用过程。

所有选项的思维导图

预处理器选项思维导图

如何使用

预处理器可以作为以下方式使用:

预处理器已发布在Maven中央仓库

    <build>
        <plugins>
...
           <plugin>
                <groupId>com.igormaznitsa</groupId>
                <artifactId>jcp</artifactId>
                <version>7.1.2</version>
                <executions>
                    <execution>
                        <id>preprocessSources</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>preprocess</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
...
        </plugins>
    </build>    

如何在命令行中使用

uber-jar可以通过CLI接口直接在Java下启动。让我们看一个在Linux命令行下启动它的简短示例:

java -jar jcp-7.1.2.jar  --i:./test --o:./result

上面的例子只是预处理./test文件夹中的文件(默认允许预处理的扩展名),并将结果文件放入./result文件夹。请记住,预处理器不会处理所有文件,例如默认情况下不会预处理XML文件。未标记为预处理的扩展名的文件将只会被复制(当然,如果该扩展名不在排除列表中)。

更复杂的例子:

java -jar jcp-7.1.2.jar  --c --r --v --f:java,xml --ef:none --i:./test --o:./result  '--p:HelloWorld=$Hello world$'
  • --c 在工作前清空目标文件夹
  • --r 从预处理后的结果文件中删除所有Java风格的注释
  • --v 显示预处理过程的详细日志
  • --f 将.java和.xml文件包含在预处理中(默认情况下,预处理器不预处理XML文件,必须明确定义扩展名)
  • --ef 不从预处理中排除任何扩展名
  • --i 使用./test作为源文件夹
  • --o 使用./result作为目标文件夹
  • --p 定义名为HelloWorld的全局变量,内容为'Hello world'
  • --z 在替换前开启文件内容检查,如果内容相同,预处理器将不会替换文件
  • --es 允许注释和指令之间有空白(默认情况下是关闭的)

一些示例

带有指令的Java源代码示例

在Java中,注入指令而不破坏工具和编译器工作的唯一允许方式是使用注释空间,因此预处理器使用它。

//#local TESTVAR="TEST LOCAL VARIABLE"
//#echo TESTVAR=/*$TESTVAR$*/
//#include "./test/_MainProcedure.java"

public static final void testproc()
{
 System.out.println(/*$VARHELLO$*/);
 System.out.println("// Hello commentaries");
 //#local counter=10
        //#while counter!=0
        System.out.println("Number /*$counter$*/");
        //#local counter=counter-1
        //#end
 System.out.println("Current file name is /*$SRV_CUR_FILE$*/");
 System.out.println("Output dir is /*$SRV_OUT_DIR$*/");
 //#if issubstr("Hello","Hello world")
 System.out.println("Substring found");
 //#endif
}

多部分文档

与普通文档相比,Java文档至少有两个部分 - 前缀(存放导入和特殊信息)和主体。为了访问这些部分,有特殊的预处理指令//#prefix[-|+]//#postfix[-|+]。它们允许打开或关闭前缀和后缀部分的输出。

//#prefix+
 import java.lang.*;
 //#prefix-
 public class Main {
  //#prefix+
  import java.util.*;
  //#prefix-
  public static void main(String ... args){}
 }

如何从源代码中删除所有注释

有时从源代码中完全删除所有注释是非常有用的,JCP包含了这种可能性,可以通过特殊标志或命令行开关激活。下面的例子展示了如何使用CLI删除所有注释:

java -jar ./jcp-7.1.2.jar --i:/sourceFolder --o:/resultFolder -ef:none --r
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号