Doxy » 历史记录 » 版本 1
om 经理1, 2017-05-04 17:32
| 1 | 1 | om 经理1 | *doxygen 使用规范* |
|---|---|---|---|
| 2 | 1 | om 经理1 | |
| 3 | 1 | om 经理1 | 按规范使用将形成效果如下效果（简单文字形式示意）： |
| 4 | 1 | om 经理1 | |
| 5 | 1 | om 经理1 | <pre> |
| 6 | 1 | om 经理1 | xxxXXX v1.0 20170504 |
| 7 | 1 | om 经理1 | 简单描述 |
| 8 | 1 | om 经理1 | --------------------------------------- |
| 9 | 1 | om 经理1 | 首页 相关页面 模块 类 文件 示例 |
| 10 | 1 | om 经理1 | --------------------------------------- |
| 11 | 1 | om 经理1 | 首页TITLE |
| 12 | 1 | om 经理1 | --------------------------------------- |
| 13 | 1 | om 经理1 | 首页内容 |
| 14 | 1 | om 经理1 | 如： |
| 15 | 1 | om 经理1 | 标题一 |
| 16 | 1 | om 经理1 | 内容一 |
| 17 | 1 | om 经理1 | |
| 18 | 1 | om 经理1 | 标题二 |
| 19 | 1 | om 经理1 | 内容二 |
| 20 | 1 | om 经理1 | </pre> |
| 21 | 1 | om 经理1 | |
| 22 | 1 | om 经理1 | *文件组织* |
| 23 | 1 | om 经理1 | *首页* 可以在.md文件中，也可以放在omXxx中 |
| 24 | 1 | om 经理1 | !!注意!! 在代码文件中，以下内容需要放在块注释中，参考doxygen使用说明 |
| 25 | 1 | om 经理1 | 注意：.md文件中的内容不需要放在块注释中！！！ |
| 26 | 1 | om 经理1 | // README.md 里面为首页，也可含相关页面，首页也可放在主文件中（如：omXxx.cpp) |
| 27 | 1 | om 经理1 | <pre> |
| 28 | 1 | om 经理1 | /** \mainpage 采集数据实时上传应用 |
| 29 | 1 | om 经理1 | * |
| 30 | 1 | om 经理1 | * \section note1 整体说明 |
| 31 | 1 | om 经理1 | * 整体说明内容。。。 |
| 32 | 1 | om 经理1 | * |
| 33 | 1 | om 经理1 | * \section note2 设计说明 |
| 34 | 1 | om 经理1 | * 设计说明内容。。。 |
| 35 | 1 | om 经理1 | * |
| 36 | 1 | om 经理1 | * \section note3 功能模块 |
| 37 | 1 | om 经理1 | * 功能模块说明。。。 |
| 38 | 1 | om 经理1 | * |
| 39 | 1 | om 经理1 | */ |
| 40 | 1 | om 经理1 | </pre> |
| 41 | 1 | om 经理1 | |
| 42 | 1 | om 经理1 | *相关页面* 可放在 .md 里 也可以放在相应模块主文件中 |
| 43 | 1 | om 经理1 | // 各主要功能模块均建立一页面，内容有：功能说明 设计说明 注意项 |
| 44 | 1 | om 经理1 | // 同时也应该包括如下标准页面：修改日志 |
| 45 | 1 | om 经理1 | // 一些页面示例 |
| 46 | 1 | om 经理1 | <pre> |
| 47 | 1 | om 经理1 | /** \page pageLog 修改日志 |
| 48 | 1 | om 经理1 | * \section log4 20170422 补丁 |
| 49 | 1 | om 经理1 | * 修改内容。。。 |
| 50 | 1 | om 经理1 | * |
| 51 | 1 | om 经理1 | * \section log3 20170412 发布版本 |
| 52 | 1 | om 经理1 | * 修改内容。。。 |
| 53 | 1 | om 经理1 | * |
| 54 | 1 | om 经理1 | * \section log2 20170410 测试完成一 |
| 55 | 1 | om 经理1 | * 修改内容。。。 |
| 56 | 1 | om 经理1 | * |
| 57 | 1 | om 经理1 | * \section log1 20170401 原型 |
| 58 | 1 | om 经理1 | * 修改内容。。。 |
| 59 | 1 | om 经理1 | * |
| 60 | 1 | om 经理1 | */ |
| 61 | 1 | om 经理1 | |
| 62 | 1 | om 经理1 | /** \page PostOneNet PostOneNET模块 |
| 63 | 1 | om 经理1 | * \section note1-1 需求 |
| 64 | 1 | om 经理1 | * 用户角度需求说明内容。。。 |
| 65 | 1 | om 经理1 | * |
| 66 | 1 | om 经理1 | * \section note2-2 功能 |
| 67 | 1 | om 经理1 | * 功能说明内容。。。 |
| 68 | 1 | om 经理1 | * |
| 69 | 1 | om 经理1 | * \section note2-2 设计 |
| 70 | 1 | om 经理1 | * 设计说明内容。。。 |
| 71 | 1 | om 经理1 | * |
| 72 | 1 | om 经理1 | * \section note2-2 实现 |
| 73 | 1 | om 经理1 | * 实现说明内容。。。 |
| 74 | 1 | om 经理1 | * |
| 75 | 1 | om 经理1 | * \section note2-2 测试 |
| 76 | 1 | om 经理1 | * 测试说明内容。。。 |
| 77 | 1 | om 经理1 | * |
| 78 | 1 | om 经理1 | */ |
| 79 | 1 | om 经理1 | </pre> |
| 80 | 1 | om 经理1 | |
| 81 | 1 | om 经理1 | *模块* 一般放 .h 中，重要说明放在 .cpp 中 |
| 82 | 1 | om 经理1 | <pre> |
| 83 | 1 | om 经理1 | 参考doxygen使用说明 |
| 84 | 1 | om 经理1 | </pre> |
| 85 | 1 | om 经理1 | |
| 86 | 1 | om 经理1 | 附件带一示例，可下载用工具生成html，看下结果 |