Eclipse c++注释模板以及注释文档生成

首先注释可以使用中文，主要目的是为了让其他人看懂。

注释可以通过eclipse模板设置进行规范：Windows---preferences---C/C++----Code Style----CodeTemplates。

下面介绍如何在写代码过程中可以设置快捷键自动输入模板：

首先设置相关模板输入，Windows-preferences-C/C++-Editor-Templates，加入自定义2个模板，zsdata（数据类型定义注释模板）, zsfunc（函数注释模板）。

zsdata如下设置：

/**  简述${cursor}

 * 

 *   详细描述

 */

zsfunc如下设置：

/**简述 ${cursor}

 * 

 * 这里写该函数的详述信息

 * @param [in] (输入参数说明，包括每个参数的作用、取值及参数间关系)

 * @param [out] (输出参数的说明)

 * @return (返回值的说明)

 * @see    (本函数参考其它的相关的函数，这里作一个链接)

 * @note   (描述需要注意的问题)

*/

其次设置快捷键：Windows-preferences-General-Keys:

设置C/C++Content Assist(Templates Proposals)的快捷键为ALT+Z。另外一个很重要的快捷键是Word Completion，原始快捷键是ALT+/，可以设置为ALT+X等更方便的方式。

doxygen是代码文档工具。

下载地址：www.doxygen.org

Graphviz

这个工具配合doxygen使用，可以提取函数，模块之间的调用关，非常清晰。

下载地址：http://www.graphviz.org/

使用Doxygen工具，通过配置工程源文件路径等设置后，自动就生成帮助文档，集成graphviz可以有文件关系图示。

如有需要，生成的html还再用HTML Help Workshop生成chm，这里不另述。