XT Document

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== 小工具：源码头文件解析器 ======

[[ftp://ftp.x9x1.com.cn/_DevTool/HeaderParser|执行文件]]

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

使用方法：

1. 语法
<code>
parser.exe <input> <output> <namespace>
</code>

  * <input>，输入的头文件名;
  * <output>, 输出的格式文档；
  * <namespace>, 该头文件所在的命名空间

2. 参考[[ftp://ftp.x9x1.com.cn/_DevTool/HeaderParser/DoParse.BAT|示例]]
<code>
parse.exe D:\Document\xt\src\project\pre-domain\mesh\node.h D:\Document\xt\format_doc\domain domain
</code>

3. 注意事项
  * 该工具基于Qt开发，运行时Qt库((向开发经理询问))必须可用

4. 如何生成文档报告
  * 在本地对头文件进行解析生成txt格式文档
  * 对相应条目进行补充说明（如类的介绍，函数的功能说明，成员变量的说明，函数参数的说明等），可参考[[class:domain:element|Element说明]]
  * 进入[[https://www.dokuwiki.org/manual|预览页面]]
  * 点击页面右边工具栏最上面编辑按钮，进入[[https://www.dokuwiki.org/manual?do=edit&rev=0|草稿页面]]
  * 将txt格式文档内容替换草稿内容，进行预览
  * 将预览内容拷入到Word中进行排版即可

XT Document

User Tools

Site Tools

Page Tools