首页 > 代码库 > 代码注释格式化

代码注释格式化

最近因为项目需要,整理Qt代码, 很多注释格式不符合Doxygen需要。


需求:

找到源代码中函数实现地方, 解析之前的注释, 重新生成代码注释


后面2个需求,很好解决。现在就是第一个需求比较难实现。


最先想到的是解析器,第一个想到的就是yacc, 可惜找了半天也没找到现成的c++的产生式, 估计是c++太复杂了。

不过,找到了下面文档,对如何做解释器有了一定了解。

http://www.nobugs.org/developer/parsingcpp/


了解下来, 基本上Clang是最强大的开源工具。不过,做一个C++解释器,明显超出1个星期的工作量, 自己要找的是一个

学习,研究,加使用能一天就解决的工具。


接下来换一个思路, 看看Perl/Python是否有现成的库支持。

Python 找到了封装Clang的库, 可是很遗憾, 尝试了2次, 编译失败,无法安装成功, 短期内看来无法解决,只能放弃。

http://eli.thegreenplace.net/2011/07/03/parsing-c-in-python-with-clang/


pycparser 不支持c++

CppHeaderParser 支持头文件解释 格式很好,满足需求, 可惜不支持源代码。


gcc-xml 满足要求


找到了工具,接下来的任务就简单了。


整个实现的核心问题是,如何知道一个文件定义了多少类, 实现了多少函数, 分别在文件的多少行。

能够获取这些信息, 接下来就是常规的数据格式化问题了。


ctag 也能解决这个问题, 不过不方便的是ctag 生成的是函数的正则表达式, 使用起来稍微有点麻烦, 没有行号方便。



代码注释格式化