生成文档

生成文档

    在emacs中可以使用doxymacs来生成注释，再配合doxymacs就可以生成文档。要生成中文文档，在emacs中必须使用utf-8的中文字体。所以需要加入下面的代码到~/.emacs中。

;; For my language code setting (UTF-8)
(setq current-language-environment "UTF-8")
(setq default-input-method "chinese-py")
(setq locale-coding-system 'utf-8)
(set-terminal-coding-system 'utf-8)
(set-keyboard-coding-system 'utf-8)
(set-selection-coding-system 'utf-8)
(prefer-coding-system 'utf-8)
    通过doxymacs很容易生成doxy格式的注释。下面的代码就是一个doxy格式的代码注释。
/**
 * @file   49.cc
 * @author wg <wg@wg-laptop>
 * @date   Sat Feb 14 13:55:04 2009
 *
 * @brief  扩大数组大小
 *
 *
 */

#include  <iostream>

void ChangeSizeId(int iArr[], int size);

int main(int argc, char * argv[])
{
    int a[10];
    for (int i = 0; i < 10; i++) {
        a[i] = i;
    }
    ChangeSizeId(a, 10);
}

/**
 * Change array size
 *
 * @param iArr
 * @param size 数组大小
 */
void ChangeSizeId(int iArr[], int size)
{
    int *p = new int(2 * size);
    for (int i = 0; i < size; i++) {
        *(p + i) = iArr[i];
    }
}

    doxygen可以产生多种文档，默认产生html和latex两种格式的文档。用doxygen生成文档主要是三个步骤：
1）doxygen -g filename
   生成filename配置文件
2）编辑配置文件filename
   配置文件主要有下面几个参数：
PROJECT_NAME       项目名称 
PROJECT_NUMBER      项目版本
OUTPUT_DIRECTORY     输出的目录 
INPUT           输入的目录
OUTPUT_LANGUAGE = Chinese 设定语言
FILE_PATTERNS    = *.c *.h *.cpp .... 分析的文件后缀
INLINE_SOURCES = YES   会显示源码
RECURSIVE ＝ YES  INPUT所指定目录的所有子目录都会被处理
SOURCE_BROWSER  = YES  Doxygen会产生出源文件的列表，以供查阅
EXCLUDE 指定不希望处理的目录或文件
EXCLUDE_PATTERNS  设定不希望处理的文件的后缀与FILE_PATTERNS类似
3）doxygen filename
    生成文档完毕。你可以在目录下查看多了两个文件夹html和latex。里面就是生成的文档。
    doxygen 除了 html latex 还可以生成 man rtf xml ， 而且也支持生成数学公式，以及图片 。具体的以后研究了，在写出来。

本文出自 “cmdblock” 博客，转载请与作者联系！