CuraEngine的注释生成工具

Table of Contents

• 概述
• 生成说明文档
• doxygen的语法
• 其他

概述

CuraEngine源码有w行，如果没有详细的说明文档那简直不是人看的。好在有doxygen这通过注释个自动生成代码文档的工具，还有graphviz可以生成依赖图等。效果如图：

生成说明文档

1. 下载 doxygen：http://www.stack.nl/~dimitri/doxygen/download.html 
   graphviz：http://www.graphviz.org/ 
   
2. 配置 打开doxygen GUI界面，这是用来生成配置文件的。
   详细的配置过程参见：http://www.tuicool.com/articles/r6nuUjF ，其中
   OUTPUT_DIRECTORY这行要屏蔽，INPUT这行要屏蔽，GENERATE_HTMLHELP =YES，OUTPUT_LANGUAGE=Chinese
   建议生成html文档，graphviz的选项最好都选上，生成的配置文件复制到vs工程目录里。
3. 与vs集成 详情参见：http://www.cnblogs.com/bluepointcq/archive/2006/08/18/480497.html
   在VS环境中：Tools->External Tools->Add 
   Title: Doxygen 
   Command: D:\Program Files\doxygen\bin\doxygen.exe（doxygen的安装目录）
   Arguments: $(ProjectDir)\default.doxygen 
   Initial directory: $(ProjectDir) 
   以后点击 工具-Doxygen 就可以在vs当前目录生成说明文档了。

doxygen的语法

要生成格式化的文档，必然对注释有语法要求。更详细的语法参考官网，这里只是列举最简单的用法，不过对于CuraEngine已经够用了。（原作者貌似也就用了一点点而已）

• 用在函数或者变量之前,单行

/*! 注释内容 */

• 用在变量之后,单行

/*!< 注释内容 */  
或者
//!< 注释内容

• 用在函数或者变量之前，多行

/** 
 * 注释内容
 */
     或者
/*！
 * 注释内容
 */

• 宏注释

  /*! 
    \def MAX(x,y)  宏的具体注释
  */
  

• 函数参数
  1. \property 属性
  2. \param 参数名 描述 参数说明
  3. \return 描述 返回值说明
  4. \a 增强视觉感受 
• TODO事项

  //TODO: 待办事项
  

  

• 高级用法
  自己查资料啊~比如这个鬼 

其他

大致就这么多，反正培养良好的注释习惯肯定有好处的~

https://fhln.blog.ustc.edu.cn/