Posted on 15-09-2010
Filed Under (技术) by waterlin

写了一大堆的代码,要生成 C++ 类的文档及关系图怎么办呢?对,就是生成 MFC 类库示意图那样让人赏心悦目的东西。

总体来说,生成这种文档有三种思路:

  1. Doxygen 来自动生成文档

    用 Doxygen 可以跨平台,在维护代码的同时,维护文档,很方便很实用。

    如果需要生成类的关系图,可以用 Doxygen 配上 Graphviz,安装好 Graphviz 后,需要把该可执行目录添加到系统的 Path 里,这样在 Doxygen 里就可以用 Graphviz 来生成类的关系图。

    如果是在 vim, Emacs 这类文本编辑器里,则可以很自然地使用宏操作来插入 Doxygen 注释;如果是用 Visual Studio 的话呢,也是可以用 DoxyComment add-in for Visual Studio 2005 之类的东西来完成。

    用 Doxygen 来生成文档有一个要注意的地方,源代码文件的编码和 Doxygen 选用的字符编码需要一致,否则生成的文档会乱码。现在这个年代,当然是统一用 UTF-8 好一点了。

  2. 用 Visual Studio 的 Class Diagram

    MSDN 上专门有关于使用 Class Diagram 的介绍。

  3. 用 Visio 来画 UML 图,纯人肉体力活,累,难与代码同步,不推荐使用。

© 2010, 浏忙大爆炸. All rights reserved.
除非注明,浏忙大爆炸文章均为原创,转载请以链接形式标明本文地址。

Post a Comment
Name:
Email:
Website:
Comments: