状态机编程思想(2):删除代码注释(目前支持C/C++和Java)
前言
有时为了信息保密或是单纯阅读代码,我们需要删除注释。
之前考虑过正则表达式,但是感觉实现起来相当麻烦。而状态机可以把多种情况归为一类状态再行分解,大大简化问题。本文就是基于状态机实现的。
目录
- 删除C/C++代码注释
- 删除Java代码注释
- 程序
- 参考
删除C/C++代码注释
需要考虑的情况
- //
- /* */
- //和/* */嵌套(注意不存在/* */和/* */嵌套)
- 折行注释(用\间隔)
- 字符中存在的/和*
- 字符串中存在的//和/* */
- 字符串中的折行代码(用\间隔)
- 头文件中可能存在的/
状态转移描述
思路参考了博客http://www.cnblogs.com/zhanghaiba/p/3569928.html#3853787,写得很赞。
本文基于上面所述博文进行了以下修改或是优化:
- 原博文没有考虑/***/的情况(其中*的个数为奇数),已修正
- 切换到了windows平台下,支持windows换行\r\n(并请注意:如果原文件末尾没有回车,会自动插入)
- 状态量优化为枚举常量
- 状态转移由if...else...elseif结构改为switch...case结构,更为清晰,对于大型代码,效率更高
其中,除状态NOTE_MULTILINE_STAR外,其余状态下均需进行字符(串)处理,以保持正确输出。详见文末代码。
删除Java代码注释
需要考虑的情况
- //
- /* */
- /** */
- //和/**/嵌套(注意不存在/* */和/* */嵌套,不存在/** */和/** */嵌套,不存在/* */和/** */嵌套)
- //和/** */嵌套
- 字符中存在的/和*
- 字符串中存在的//、/**/以及/** */
状态转移描述
可以看到,java中的注释规则更为简单,其中/** */完全可以用/* */的状态涵盖。且不会出现折行注释和字符串折行的情况,因此状态更加简单,有兴趣的可以画一画,这里就不画图了。换句话说,上面删除C/C++注释的程序完全可以用来删除java注释。
程序
import java.io.FileInputStream;
import java.io.InputStreamReader;
import java.io.BufferedReader; import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.io.BufferedWriter; import java.io.IOException; import java.util.Scanner; /**
* @author xiaoxi666
* @version 1.0.0 2017.12.01
*/ public class deleteCAndCplusplusAndJavaNote { /**
* 状态
*/
enum State {
CODE, // 正常代码
SLASH, // 斜杠
NOTE_MULTILINE, // 多行注释
NOTE_MULTILINE_STAR, // 多行注释遇到*
NOTE_SINGLELINE, // 单行注释
BACKSLASH, // 折行注释
CODE_CHAR, // 字符
CHAR_ESCAPE_SEQUENCE, // 字符中的转义字符
CODE_STRING, // 字符串
STRING_ESCAPE_SEQUENCE// 字符串中的转义字符
}; /**
* @function 删除代码中的注释,以String形式返回
* @param strToHandle 待删除注释的代码
* @return 已删除注释的代码,String字符串形式
*/
public static String delete_C_Cplusplus_Java_Note(String strToHandle) {
StringBuilder builder = new StringBuilder(); State state = State.CODE;// Initiate
for (int i = 0; i < strToHandle.length(); ++i) {
char c = strToHandle.charAt(i);
switch (state) {
case CODE:
if (c == '/') {
state = State.SLASH;
}else {
builder.append(c);
if(c=='\'') {
state=State.CODE_CHAR;
}else if(c=='\"') {
state=State.CODE_STRING;
}
}
break;
case SLASH:
if (c == '*') {
state = State.NOTE_MULTILINE;
} else if (c == '/') {
state = State.NOTE_SINGLELINE;
} else {
builder.append('/');
builder.append(c);
state = State.CODE;
}
break;
case NOTE_MULTILINE:
if(c=='*') {
state=State.NOTE_MULTILINE_STAR;
}else {
if(c=='\n') {
builder.append("\r\n");//保留空行,当然,也可以去掉
}
state=State.NOTE_MULTILINE;//保持当前状态
}
break;
case NOTE_MULTILINE_STAR:
if(c=='/') {
state=State.CODE;
}else if(c=='*') {
state=State.NOTE_MULTILINE_STAR;//保持当前状态
}
else {
state=State.NOTE_MULTILINE;
}
break;
case NOTE_SINGLELINE:
if(c=='\\') {
state=State.BACKSLASH;
}else if(c=='\n'){
builder.append("\r\n");
state=State.CODE;
}else {
state=State.NOTE_SINGLELINE;//保持当前状态
}
break;
case BACKSLASH:
if(c=='\\' || c=='\r'||c=='\n') {//windows系统换行符为\r\n
if(c=='\n') {
builder.append("\r\n");//保留空行,当然,也可以去掉
}
state=State.BACKSLASH;//保持当前状态
}else {
state=State.NOTE_SINGLELINE;
}
break;
case CODE_CHAR:
builder.append(c);
if(c=='\\') {
state=State.CHAR_ESCAPE_SEQUENCE;
}else if(c=='\'') {
state=State.CODE;
}else {
state=State.CODE_CHAR;//保持当前状态
}
break;
case CHAR_ESCAPE_SEQUENCE:
builder.append(c);
state=State.CODE_CHAR;
break;
case CODE_STRING:
builder.append(c);
if(c=='\\') {
state=State.STRING_ESCAPE_SEQUENCE;
}else if(c=='\"') {
state=State.CODE;
}else {
state=State.CODE_STRING;//保持当前状态
}
break;
case STRING_ESCAPE_SEQUENCE:
builder.append(c);
state=State.CODE_STRING;
break;
default:
break;
}
}
return builder.toString();
} /**
* @function 从指定文件中读取代码内容,以String形式返回
* @param inputFileName 待删除注释的文件
* @return 待删除注释的文件中的代码内容,String字符串形式
* @note 输入文件格式默认为 UTF-8
*/
public static String readFile(String inputFileName) {
StringBuilder builder = new StringBuilder();
try {
FileInputStream fis = new FileInputStream(inputFileName);
InputStreamReader dis = new InputStreamReader(fis);
BufferedReader reader = new BufferedReader(dis);
String s;
// 每次读取一行,当改行为空时结束
while ((s = reader.readLine()) != null) {
builder.append(s);
builder.append("\r\n");// windows系统换行符
}
reader.close();
dis.close();
fis.close();
} catch (IOException e) {
e.printStackTrace();
System.exit(1);
}
return builder.toString();
} /**
* @function 将删除注释后的代码保存到指定新文件
* @param outputFileName 保存“删除注释后的代码”的文件的文件名
* @param strHandled 删除注释后的代码
*/
public static void writeFile(String outputFileName, String strHandled) {
try {
FileOutputStream fos = new FileOutputStream(outputFileName);
OutputStreamWriter dos = new OutputStreamWriter(fos);
BufferedWriter writer = new BufferedWriter(dos);
writer.write(strHandled);
writer.close();
dos.close();
fos.close();
System.out.println("code that without note has been saved successfully in " + outputFileName);
} catch (IOException e) {
e.printStackTrace();
}
} /**
* @function 读取待处理文件,删除注释,处理过的代码写入新文件
* @param args
*/
public static void main(String[] args) {
Scanner in = new Scanner(System.in);
//待删除注释的文件
System.out.println("The fileName that will be delete note:");
String inputFileName = in.nextLine();
//保存“删除注释后的代码”的文件
System.out.println("The fileName that will save code without note:");
String outputFileName = in.nextLine(); String strToHandle = readFile(inputFileName);
String strHandled = delete_C_Cplusplus_Java_Note(strToHandle);
writeFile(outputFileName, strHandled); } }
说明
- 本程序保留注释占用行,也就是说,注释以外的代码原样保留(行数也不会变),注释行变为空白。
- 不检测文件后缀(这就意味着把代码写在.txt里面也可以处理),有需求的可以自行添加。
- 本程序适用于windows平台,其他平台如linux和mac请替换“\r\n”换行符。文件格式默认为UTF。
- 有兴趣的可以封装成图形界面,直接拖入文件处理,更好用。
- 本程序经过大量测试未发现bug,若读者发现bug,欢迎提出。
参考
- 怎样删除C/C++代码中的所有注释?浅谈状态机的编程思想: http://www.cnblogs.com/zhanghaiba/p/3569928.html#3853787
- 谁能写出个删除注释的正则表达式:http://bbs.csdn.net/topics/380183706
- 正则表达式删除代码的注释: http://blog.csdn.net/conquer0715/article/details/14446463
状态机编程思想(2):删除代码注释(目前支持C/C++和Java)的更多相关文章
- 《Java编程思想第四版》附录 B 对比 C++和 Java
<Java编程思想第四版完整中文高清版.pdf>-笔记 附录 B 对比 C++和 Java “作为一名 C++程序员,我们早已掌握了面向对象程序设计的基本概念,而且 Java 的语法无疑是 ...
- ★ java删除代码注释
package com.witwicky.util; import java.io.BufferedReader; import java.io.BufferedWriter; import java ...
- [Java编程思想-学习笔记]第3章 操作符
3.1 更简单的打印语句 学习编程语言的通许遇到的第一个程序无非打印"Hello, world"了,然而在Java中要写成 System.out.println("He ...
- 面向对象的编程思想和Java中类的概念与设计
面向对象的编程思想学习,面向对象内容的三条主线;1.java类及类的对象2.面向对象的三大特征3.其他关键字学习内容:3.1面向对象与面向过程面向对象与面向过程在应用上的区别 Java中类的概念与设计 ...
- 关于 java编程思想第五版 《On Java 8》
On Java 8中文版 英雄召集令 这是该项目的GITHUB地址:https://github.com/LingCoder/OnJava8 广招天下英雄,为开源奉献!让我们一起来完成这本书的翻译吧! ...
- 怎样删除C/C++代码中的所有注释?浅谈状态机的编程思想
K&R习题1-23中,要求“编写一个程序,删除C语言程序中所有的注释语句.要正确处理带引号的字符串与字符常量.在C语言中,注释不允许嵌套”. 如果不考虑字符常量和字符串常量,问题确实很简单.只 ...
- 撰写一篇博客要求讲述四则运算2的设计思想,源程序代码、运行结果截图、编程总结分析,并按照PSP0级的要求记录开发过程中的时间记录日志。
一.撰写一篇博客要求讲述四则运算2的设计思想,源程序代码.运行结果截图.编程总结分析,并按照PSP0级的要求记录开发过程中的时间记录日志. 1.设计思想: ①创建test.jsp建立第一个前端界面,提 ...
- 函数式编程思想概述和冗余的Runnable代码
函数式编程思想概述 在数学中,函数就是有输入量.输出量的一套计算方法 相对而言,面向对象过分强调必须通过对象的形式来做事情,而函数式的思想是尽量忽略复杂的面向对象的复杂语法--是强调做什么而不是以什么 ...
- Eclipse删除代码中所有注释及空格
替换方法: Ctrl+F 删除java注释: /\*{1,2}[\s\S]*?\*/ Ctrl+F 删除xml注释: <!-[\s\S]*?--> Ctrl+F 删除空白行: ^\ ...
随机推荐
- Python+OpenCV图像处理(一)
Python+OpenCV图像处理(一): 读取,写入和展示图片 调用摄像头拍照 调用摄像头录制视频 1. 读取.写入和展示图片 图像读入:cv2.imread() 使用函数cv2.imread() ...
- JavaScript之“创意时钟”项目
“时钟展示项目”说明文档(文档尾部附有相应代码) 一.最终效果展示: 二.项目亮点 1.代码结构清晰明了 2.可以实时动态显示当前时间与当前日期 3.界面简洁.美观.大方 4.提高浏览器兼容性 三.知 ...
- (转)MySQL存储过程/存储过程与自定义函数的区别
转自:http://www.cnblogs.com/caoruiy/p/4486249.html 语法: 创建存储过程: CREATE [definer = {user|current_user}] ...
- Spark 作业调度相关术语
作业(Job):RDD 中由行动操作所生成的一个或多个调度阶段 调度阶段(Stage):每个作业会因为 RDD 间的依赖关系拆分成多组任务集合,称为调度阶段,也叫做任务集(TaskSet).高度阶段的 ...
- 微软Tech Summit 2017,等你来打Call
2017年10月31至11月3日,由微软举办的Tech Summit 2017技术暨生态大会将在北京盛大举办,要在北京连开四天.今年的技术大会看头十足,不仅有大咖级人物带来十二大主题课程,更有三天四场 ...
- EJBCA安装教程+postgresql+wildfly10
1. 安装环境说明 笔者在本机的虚拟机下进行的安装,数据库已经装好了的. ubuntu16.04 x64 postgresql:9 wildfly10 2. 安装前准备 下载必要软件包(直接到官网下载 ...
- Android的主线程和子线程
在一个Android 程序开始运行的时候,会单独启动一个Process.默认的情况下,所有这个程序中的Activity或者Service(Service和 Activity只是Android提供的Co ...
- JavaScript--我发现,原来你是这样的JS:面向对象编程OOP[1]--(理解对象和对象属性类型)
一.介绍 老铁们,这次是JS的面向对象的编程OOP(虽然我没有对象,心累啊,但是可以自己创建啊,哈哈). JS高程里第六章的内容,这章内容在我看来是JS中很难理解的一部分.所以分成三篇博客来逐个理清. ...
- gsoap入门实例
环境VS2008,gsoap_2.8,win7 实例场景:在客户端输入一个字符串,然后传递给服务端计算字符串长度并返回给客户端(附加一些加减乘除法的实现): 将..\gsoap-2.8\gsoap\b ...
- 不怕你配置不对,就怕你看的资料不对!MIM 与 SharePoint 同步完全配置指南。
为了更好的同步 User Profile,在 SharePoint 2010 中首次引入了 FIM (ForeFront Identity Manager) 用于编辑 User Profile 的同期 ...