这两天接手了一个项目，项目定义了一种自己语法，所以有了判断注释的需求。
这里自己简单实现了一个，代码非常精简。


提供的注释语法和C++是一模一样的， 允许 // 和 /* */两种注释


两个问题：
1、如何判断某一行是否为注释行。
2、如何判断是否“进入”了注释段，也就是在/* */中间。


先说第2点，思路：从上往下，一行一行的检查。
用一个flag标识是否”进入”了注释，具体在一行当中，遇到/* flag 置1，遇到 */ 置0；这样即使一行中有多个/* */也不会判断错误。
比如  /*int x*/ printf(); /* int y */ /*int z;  之后
就进入了注释段了，在遇到*/之前接下里的行都是注释行。但它本身并不是注释行。
这就说到第1点了，除了这个以下几种情况也都是注释行，如果一行是以//开头，仅有/*两个字符 ，仅有*/两个字符，以/*开头类似这种的/* xx */ /* x xxx */  //xxx，以/*开头类似 /* int x 这种的。
很自然的想到递归计算：
在一行中，前面部分闭合了就不用管了，把后面的子串继续递归。只要遇到上面说的几种情况中的一种就说明是注释行。递归结束还没遇到说明是普通行。
而且在递归中也可以更新flag是否进入了注释段。 两者可以在同一个函数中进行，非常方便。
判断一行本身是否为注释行以及更新/*、*/的函数如下。


bool Counter::judgeAndUpdateComment(string line, bool& flag)  
{
	// /* xxxxxx */ /* x xxx */  //xxxx
	// /*xx */ int x /*
	if(line[0] == '/' && line[1] == '/') return true;
	if(line[0] == '*' && line[1] == '/' && line.length()==2) {flag = false; return true;}
	if(line[0] == '/' && line[1] == '*' && line.length()==2) return flag = true;
	if(line[0] == '/' && line[1] == '*' && line.find("*/")==string::npos) return flag = true;
	string::size_type idx = line.find("/*");
	if(idx != string::npos)   
	{
		flag = true;
	}
	if(flag)
	{
		idx = line.find("*/");
		if(idx != string::npos)
		{
			flag = false;
			line[idx] = line[idx+1] = ' ';
			string sub = line.substr(idx+2,line.length()-idx-2);
			trim(sub);
			if (judgeAndUpdateComment(sub,flag)) return true;
		}
	}
	return false;
}


当然，要配合下面的函数里调用


void Counter::countOneFile(string filepath)
{
	
	ifstream file;
	file.open(filepath,ios::in);
	if (!file.is_open())
	{
		cout << "can't open the file :" << filepath << endl;
		exit(1);
	}
	char buffer[10000];
	bool comment_flag = false;  
	while (!file.eof() )  
    {  
        file.getline(buffer,10000);  
		string line(buffer);
		trim(line);
		if (line.empty())
		{
			m_blank_line++;
		}
		else if(comment_flag)  //如果已经进入了注释段
		{
			m_comment_line++;
			judgeAndUpdateComment(line,comment_flag); //更新 */
		}
		else if (judgeAndUpdateComment(line,comment_flag)) // 本身是注释行
		{
			m_comment_line++;
		}
		else
		{
			m_real_line++;
		}
		
    }  
	cout << "finish: " << filepath << endl;
}
 
这里我没有考虑双引号的影响。双引号里的东西应该忽略的，但是我没有考虑，如果出现类似
string str = "abcd /* "; 的代码，程序得出的结果是灾难性的错误。有需要的同学自己加上。


完整代码 请点击：http://download.csdn.net/download/angon823/10115630

文章目录
一、简介
二、Windows下使用代码量统计工具
1. 不设置环境变量
2. 设置环境变量
三、Linux下使用代码量统计工具


今天突然遇到一个问题？要统计项目代码一共多少行，我们都知道一个项目中有许多文件，我们不可能将它们进行相加计算一共多少行。再说一个项目中也有空白行、注释行。经过查找发现一个实用的工具cloc。

一、简介
cloc是一款使用Perl语言开发的开源代码统计工具，支持多平台使用、多语言识别，能够计算指定目标文件或文件夹中的文件数（files）、空白行数（blank）、注释行数（comment）和代码行数（code）。

可以通过下面的地址进行下载：

官方网站：http://cloc.sourceforge.net/

github上：https://github.com/AlDanial/cloc/releases
二、Windows下使用代码量统计工具

首先,将下载好的cloc-1.84.exe重新放在一个cloc文件夹中,并将其重新命名为cloc.exe

以管理员的打开cmd或着你的电脑装git打开Git  Bash Here，这里我使用的管理员打开cmd
1. 不设置环境变量
命令格式：cloc.exe的文件路径+空格+项目代码路径

D:\Software\cloc\cloc.exe C:\Users\Salt\Desktop\学习代码svn\mysql连接


2. 设置环境变量
将D:\Software\cloc添加到环境变量path中，通过echo %Path%来进行查看是否设置成功。

进项目文件夹下，在命令行输入：cloc .



可以看到，在Windows命令行工具中，将各种变成语言的文件数、空行数、注释行数以及代码行数分别展示出来了，并且给出了总的统计结果。
关于更多的使用方法，可以通过cloc -help来进行查阅，可选项特别多，但是我认为cloc .就已经满足我的基本需求了。如果有需要的时候在进行学习。

其他命令：
cloc targetFile --report-file=result.txt  //将targetFile文件的代码统计结果写入result.txt文件中
cloc targetFile --sql=result.txt  //用SQL语句的形式将统计结果写入result.tx


三、Linux下使用代码量统计工具
Ubuntu下安装：sudo apt-get install cloc



统计C语言目录下的代码量：cloc .



cloc的本质是一个perl脚本：file `which cloc`



分享一个好用代码统计工具：

链接: https://pan.baidu.com/s/1fIhYorbWfBEp7b-9ZPVtKg 提取码: szrb

       比如想统计一个Java程序员一天写代码的工作量（如：有效代码多少行、空行多少、注释多少行等），这个小工具也许能做为一个参考的依据。
    思路：因为每个java源文件的内容基本包括java语句、空白行、注释三部份组成（不包括注解），所以要统计某个文件这三部份的内容各占多少时，只需写三个匹配这几部份内容的正则表达式即可。然后通过IO流读取文件中的每一行，并根据正则匹配的结果，累加每部份匹配的数量即可。
    注释行：单行注释（//）、多行注释、文档注释。正则：((//)|(/\\*+)|((^\\s)*\\*)|((^\\s)*\\*+/))+
    空白行：一行内只有空格、\t、\n等非可视字符表示空白行。正则：^\\s*$
    代码行：以分号“；“结束为一行有效的代码。正则：(?!import|package).+;\\s*(((//)|(/\\*+)).*)*
    实现方式：
        1、用户在控制台输入要统计的java文件路径或目录
        2、根据路径创建一个File对象，判断文件是否有效，并给出提示。最后将文件和IO流绑定
        3、循环读取文件中的某一行，并根据正则匹配的结果累记每部份匹配的数量



完整代码如下：
package regex;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.Scanner;
import java.util.regex.Pattern;

/**
 * 代码统计工具
 * 统计某个java源文件或某个目录中所有java源文件中注释、空白行、代码行各占多少行
 * 注释：包括单行注释（//）、多行注释、文档注释
 * 空白行：一行内没有任何内容的表示空白行
 * 代码行：以分号“；”结束的一条语句，可以统计为一行有效代码
 */
public class CodeStatDemo {
	
	// 记录注释行数
	static long annotationLine = 0;
	
	// 记录空白行数
	static long blankLine = 0;
	
	// 记录有效代码的行数
	static long codeLine = 0;
	
	// 代码总行数
	static long totalLine = 0;
	
	// 文件总数
	static long fileCount = 0;

	public static void main(String[] args) throws FileNotFoundException  {
		System.out.println("请输入要统计代码量的java文件或java目录：");
		Scanner in = new Scanner(System.in);
		String filePath = in.nextLine();
		
		File file = new File(filePath);
		// 根据用户输入的文件名和目录执行代码量统计
		codeStat(file);
		
		System.out.println("－－－－－－－－－－统计结果－－－－－－－－－");
		System.out.println("文件数量：" + fileCount + "个");
		System.out.println(file + "文件/目录总行数：" + totalLine);
		System.out.println("代码行数：" + codeLine);
		System.out.println("注释行数：" + annotationLine);
		System.out.println("空白行数：" + blankLine);
		long otherLine = totalLine - (codeLine + annotationLine + blankLine);
		System.out.println("其它行数：" + otherLine);
		
	}

	private static void codeStat(File file) throws FileNotFoundException {
		if (file == null || !file.exists()) 
			throw new FileNotFoundException(file + "，文件不存在！");
		
		fileCount ++;	// 文件数累加
		
		if (file.isDirectory()) {
			File[] files = file.listFiles(new FileFilter() {
				
				@Override
				public boolean accept(File pathname) {
					return pathname.getName().endsWith(".java") || pathname.isDirectory();
				}
			});
			
			for (File target : files) {
				codeStat(target);
			}
		} else {
			BufferedReader bufr = null;
			try {
				// 将指定路径的文件与字符流绑定
				bufr = new BufferedReader(new InputStreamReader(new FileInputStream(file)));
			} catch (FileNotFoundException e) {
				throw new FileNotFoundException(file + "，文件不存在！" + e);
			}
			
			// 定义匹配每一行的正则匹配器
			Pattern annotationLinePattern = Pattern.compile("((//)|(/\\*+)|((^\\s)*\\*)|((^\\s)*\\*+/))+", 
					Pattern.MULTILINE + Pattern.DOTALL);	// 注释匹配器(匹配单行、多行、文档注释)
			
			Pattern blankLinePattern = Pattern.compile("^\\s*$");	// 空白行匹配器（匹配回车、tab键、空格）
			
			Pattern codeLinePattern = Pattern.compile("(?!import|package).+;\\s*(((//)|(/\\*+)).*)*",
					Pattern.MULTILINE + Pattern.DOTALL); // 代码行匹配器（以分号结束为一行有效语句,但不包括import和package语句）
			
			// 遍历文件中的每一行，并根据正则匹配的结果记录每一行匹配的结果
			String line = null;
			try {
				while((line = bufr.readLine()) != null) {
					if (annotationLinePattern.matcher(line).find()) {
						annotationLine ++;
					}
					
					if (blankLinePattern.matcher(line).find()) {
						blankLine ++;
					}
					
					if (codeLinePattern.matcher(line).matches()) {
						codeLine ++;
					} 
					
					totalLine ++;
				}
				
			} catch (IOException e) {
				throw new RuntimeException("读取文件失败！" + e);
			} finally {
				try {
					bufr.close();	// 关闭文件输入流并释放系统资源
				} catch (IOException e) {
					throw new RuntimeException("关闭文件输入流失败！");
				}
			}
		}
	}
}
测试结果：

        最近公司项目开始统计代码注释率，毕竟完全可读的代码是不存在的，提高代码可读性最好的方式还是多写注释，这样也可以帮助后来接手的同事更快的熟悉业务逻辑。

        目前项目中的注释统计工具是cloc，戳这里可以直接去它的github首页。

        

        首页说明中可以看到该工具目前可以在各大主流的插件市场下载到，我的机器是mac，所以直接使用homebrew来安装这个工具。打开终端terminal,输入“brew install cloc”即可安装该工具。安装完成后cd进入我们需要统计代码文件夹路径下，最后使用"cloc ./"命令即可统计该文件夹下文件中的注释行数和代码行数，进而得出注释率。



       bingo！