易截截图软件、单文件、免安装、纯绿色、仅160KB

doxygen+VIM文档实用指南for C/C

摘要:
文档撰写是一项十分繁琐而且费力的工作,相信已经有很多人对此深感头痛。文档生成工具的出现最大限度地帮助程序员解决了这个问题,这些工具通常可以从程序源代码自动生成文档,大大方便了文档工作。这篇小东西主要介绍了如何用VIM和doxygen来快速生成注释,并用最少的额外劳动来完成专业水准的程序文档的过程。仅供参考,如有雷同,纯属巧合。 
关键字:
       doxygen vim doxygentoolkit chm dot lex CLanuageScanner 
补充:
本文一开始是为dylan同学准备的,后来有所扩展。本文不涉及doxygen注释的具体做法,因为可以在网上得到更多关于这方面的范例和资料。
 什么是doxygen
什么是VIM
为什么要使用doxygen+VIM
需要做什么?
1)    准备工作
2)    添加注释
3)    配置并运行doxygen
4)    编译成chm
5)    一些配置选项
Dot图形扩展
doxygen方便扩展吗?
小结
 
什么是doxygen
doxygen是一个十分好用的自由软件,是一种文档生成器,其工作机制是利用注释中的有效信息来自动生成文档。目前doxygen的最新版是(1.5.1),从http://www.doxygen.org上可以下载最新版的doxygen。1.5.1版的doxygen可处理的语言包括:
l         C/C++
l         Java
l         Python
l         PHP
l         Objective-C
l         IDL (Corba, Microsoft及KDE-DCOP类型)
l         C#
l         D
它支持以下文档格式:
l         HTML
l         XML
l         LaTeX
l         RTF
l         Unix Man Page
         有了doxygen的支持后,从软件代码到项目文档的转化十分简单,直接


相关文档:

对比显示,尚易C邮箱优于传统企业邮箱

   尚易C邮箱是一款完全打破了企业邮箱一贯模式的新产品。企业能够完全自主决定邮箱的一切,只要是企业提出的需求,无论是从单独服务器架设、独享的带宽需求、功能的定制,以及与办公OA产品或不同软件的融合等,尚易C邮箱都可以为其做到。此外,尚易C邮箱还会为每个企业配置专享技术工程师,从最初的方案拟定到后期的 ......

C实现MySQL数据库操作

       两个月前,也就是9月份,心血来潮在windows下实现了用C连接数据库,当时很是有把linux下一并给实现了。但是没有想得那么简单。这个任务一直推迟到了现在才完成,究其原因:1.我直接用eclipse开发工具,对于环境变量的设置不是很熟。2.linux系统库文件结构不熟悉,对于mysql提供的库文件没有放对 ......

C/C++软件工程师就业求职手册节选一

 1、有符号变量与无符号变量值的变换
  将有符号变量转换为无符号变量,注意负数的转换。
2、数值的交换
  //使用临时变量
   void Swap1(int &a, int &b)
  {
      int temp = a;
      a = b;
   &nbs ......

C/S与B/S架构

C/S结构,即Client/Server(客户机/服务器)结构,是大家熟知的软件系统体系结构,通过将任务合理分配到Client端和Server端,降低了系统的通讯开销,可以充分利用两端硬件环境的优势。早期的软件系统多以此作为首选设计标准。
B/S结构,即Browser/Server(浏览器/服务器)结构,是随着Internet技术的兴起,对C/S结构的一种变化 ......
© 2009 ej38.com All Rights Reserved. 关于E健网联系我们 | 站点地图 | 赣ICP备09004571号