CuraEngine的注释生成工具
来源:互联网 发布:淘宝少女装 编辑:程序博客网 时间:2024/05/16 12:05
Table of Contents
- 概述
- 生成说明文档
- doxygen的语法
- 其他
概述
CuraEngine源码有w行,如果没有详细的说明文档那简直不是人看的。好在有doxygen这通过注释个自动生成代码文档的工具,还有graphviz可以生成依赖图等。效果如图:
生成说明文档
- 下载 doxygen:http://www.stack.nl/~dimitri/doxygen/download.html
graphviz:http://www.graphviz.org/ - 配置 打开doxygen GUI界面,这是用来生成配置文件的。
详细的配置过程参见:http://www.tuicool.com/articles/r6nuUjF ,其中
OUTPUT_DIRECTORY这行要屏蔽,INPUT这行要屏蔽,GENERATE_HTMLHELP =YES,OUTPUT_LANGUAGE=Chinese
建议生成html文档,graphviz的选项最好都选上,生成的配置文件复制到vs工程目录里。 - 与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) 宏的具体注释*/
- 函数参数
- \property 属性
- \param 参数名 描述 参数说明
- \return 描述 返回值说明
- \a 增强视觉感受
- TODO事项
//TODO: 待办事项
- 高级用法
自己查资料啊~比如这个鬼
其他
大致就这么多,反正培养良好的注释习惯肯定有好处的~
https://fhln.blog.ustc.edu.cn/
0 0
- CuraEngine的注释生成工具
- CuraEngine
- 小结下javascript生成注释的工具
- iOS 生成规范注释的工具
- 注释生成工具(.Net 2.0)
- MyBatis自动生成工具去掉注释的配置
- AndroidStudio工具篇----自动生成类的注释,方法的注释
- CuraEngine的命令行参数 和 信息提示
- 3D打印机切片引擎CuraEngine源码分析<四> CuraEngine中的ReadMe解读,CuraEngine的版本介绍
- appledoc:Objective-C注释文档生成工具
- xcode 利用工具快速生成注释
- 文档注释使用javadoc工具生成自己的api帮助文档
- 在android Studio工具中设置自动生成的注释样式
- eclipse生成注释的快捷键
- java注释文档的生成
- .NET文档生成工具2.2——扩展注释标志
- 【iOS开发】---- appledoc:Objective-C注释文档生成工具
- C#.NET必备工具GhostDoc为代码生成注释文档
- Java容器
- linux-语言包出错:This error could be caused by required additional software packages which ar
- 词Ci 图片同时设置亮度和模糊度
- ios开发之 调用系统电话方式(两种)
- Android Studio App EditText获取输入的文字
- CuraEngine的注释生成工具
- 错误:OPTION SQL_SELECT_LIMIT=DEFAULT
- zzuli OJ 1057: 素数判定
- django 1.8 官方文档翻译: 3-4-3 使用基于类的视图处理表单
- HDU 1022 Train Problem I(栈)
- js 处理 ie和firefox window.frames 兼容问题
- 微信——产品设计分析报告
- 简单理解Python中的装饰器
- JDK7下载地址