状态机编程思想(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 删除空白行: ^\ ...
随机推荐
- mybatis逆向工程
一.背景 在实际开发中我们会自己去写mapper映射文件,接口,数据库表对应的实体类,如果需求任务比较少,咱们还可以慢慢的一个一个去写,但是这是不现实的,因为在工作中我们的任务是很多的,这时mybat ...
- zabbix自动截图留档_python版
1 背景 每个DB Server都有zabbix监控,除了异常情况的报警信息外,也会在日检.周检.月检等工作中用到zabbix的监控数据,对zabbix监控数据会做两种处理:1 数据分析(环比 ...
- Java8之旅(七) - 函数式备忘录模式优化递归
前言 在上一篇开始Java8之旅(六) -- 使用lambda实现Java的尾递归中,我们利用了函数的懒加载机制实现了栈帧的复用,成功的实现了Java版本的尾递归,然而尾递归的使用有一个重要的条件就是 ...
- [poj1644]放苹果
题目链接:http://poj.org/problem?id=1664 把M个同样的苹果放在N个同样的盘子里,允许有的盘子空着不放,问共有多少种不同的分法?(用K表示)5,1,1和1,5, ...
- 100. Same Tree(leetcode)
Given two binary trees, write a function to check if they are equal or not. Two binary trees are con ...
- MySQL索引(2)
一.索引基础 1. B-Tree索引 <1> 所有的值都是按顺序存储的,并且每一个叶子页到根的距离相同. <2> 顺序组织存储,很适合查找范围数据,效率会非常高. <3& ...
- MySql 5.7.20安装
1.首先上MySql的官网下载 https://dev.mysql.com/downloads/mysql/ 以我所选版本为例(免安装版),选择MYSQL Community Server 然后在右 ...
- JAVA提高十:ArrayList 深入分析
前面一章节,我们介绍了集合的类图,那么本节将学习Collection 接口中最常用的子类ArrayList类,本章分为下面几部分讲解(说明本章采用的JDK1.6源码进行分析,因为个人认为虽然JDK1. ...
- javascript算法(一)
1.实现一个函数,运算结果可以满足如下预期结果: add(1)(2) // 3 add(1, 2, 3)(10) // 16 add(1)(2)(3)(4)(5) // 15 实现: function ...
- 移动端二三事【三】:transform的注意事项
1.js操作transition时需使用驼峰命名: div.style.WebkitTransform = div.style.transform = "rotate(90deg)" ...