User Tools

Site Tools


manual:how_to_use_tools:tool_header_parser

小工具:源码头文件解析器

执行文件

源码头文件解析器主要用来解析c++/c头文件形成格式文档,集成到本DOC系统中供内部人员查阅。

使用方法:

1. 语法

parser.exe <input> <output> <namespace>
  • <input>,输入的头文件名;
  • <output>, 输出的格式文档;
  • <namespace>, 该头文件所在的命名空间

2. 参考示例

parse.exe D:\Document\xt\src\project\pre-domain\mesh\node.h D:\Document\xt\format_doc\domain domain

3. 注意事项

  • 该工具基于Qt开发,运行时Qt库1)必须可用

4. 如何生成文档报告

  • 在本地对头文件进行解析生成txt格式文档
  • 对相应条目进行补充说明(如类的介绍,函数的功能说明,成员变量的说明,函数参数的说明等),可参考Element说明
  • 点击页面右边工具栏最上面编辑按钮,进入草稿页面
  • 将txt格式文档内容替换草稿内容,进行预览
  • 将预览内容拷入到Word中进行排版即可
1)
向开发经理询问
manual/how_to_use_tools/tool_header_parser.txt · Last modified: 2020/06/20 22:43 (external edit)