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的支持后,从软件代码到项目文档的转化十分简单,直接
相关文档:
原文地址:http://www.henryxu.com/post/1.html
C++的格式化字符串经常用作格式化数字的输出、字符串合并和转换等等很多场合。
1. 格式化规定符
━━━━━━━━━━━━━━━━━━━━━━━━━━
符号 &nbs ......
尚易C邮箱是一款完全打破了企业邮箱一贯模式的新产品。企业能够完全自主决定邮箱的一切,只要是企业提出的需求,无论是从单独服务器架设、独享的带宽需求、功能的定制,以及与办公OA产品或不同软件的融合等,尚易C邮箱都可以为其做到。此外,尚易C邮箱还会为每个企业配置专享技术工程师,从最初的方案拟定到后期的 ......
Linux
下
C
开发——
gcc
,
gdb
的使用
作者:
zccst
我们学习的过程应该是一个积累的过程,有无到有,又少到多,而不能像下山的猴子。
9
月份的时候是第一次系统学习
gcc, gdb, makefile
(详见前面博客)。如今作为嵌入式系统的一个组成部分,决定重学一次,感觉理解加深了一些。
gcc
......
常用宏定义
1、防止一个头文件被重复包含
#ifndef COMDEF_H
#define COMDEF_H
//头文件内容
#endif
2、重新定义一些类型,防止由于各种平台和编译器的不同,而产生的类型字节数差异,方便移植。
typedef unsigned char boolean; /* Boolean v ......
试题1:请写一个C函数,若处理器是Big_endian的,则返回0;若是Little_endian的,则返回1
解答:
int checkCPU( )
{
{
union w
{
&n ......