Doxy » 历史记录 » 版本 2
« 上一页 -
版本 2/3
(差异) -
下一页 » -
当前版本
om 经理1, 2017-05-04 17:33
*doxygen 使用规范*
按规范使用将形成效果如下效果（简单文字形式示意）：
！！！其他参考网络学习
xxxXXX v1.0 20170504 简单描述 --------------------------------------- 首页 相关页面 模块 类 文件 示例 --------------------------------------- 首页TITLE --------------------------------------- 首页内容 如： 标题一 内容一 标题二 内容二*文件组织* *首页* 可以在.md文件中，也可以放在omXxx中 !!注意!! 在代码文件中，以下内容需要放在块注释中，参考doxygen使用说明 注意：.md文件中的内容不需要放在块注释中！！！ // README.md 里面为首页，也可含相关页面，首页也可放在主文件中（如：omXxx.cpp)
/** \mainpage 采集数据实时上传应用 * * \section note1 整体说明 * 整体说明内容。。。 * * \section note2 设计说明 * 设计说明内容。。。 * * \section note3 功能模块 * 功能模块说明。。。 * */*相关页面* 可放在 .md 里 也可以放在相应模块主文件中 // 各主要功能模块均建立一页面，内容有：功能说明 设计说明 注意项 // 同时也应该包括如下标准页面：修改日志 // 一些页面示例
/** \page pageLog 修改日志 * \section log4 20170422 补丁 * 修改内容。。。 * * \section log3 20170412 发布版本 * 修改内容。。。 * * \section log2 20170410 测试完成一 * 修改内容。。。 * * \section log1 20170401 原型 * 修改内容。。。 * */ /** \page PostOneNet PostOneNET模块 * \section note1-1 需求 * 用户角度需求说明内容。。。 * * \section note2-2 功能 * 功能说明内容。。。 * * \section note2-2 设计 * 设计说明内容。。。 * * \section note2-2 实现 * 实现说明内容。。。 * * \section note2-2 测试 * 测试说明内容。。。 * */*模块* 一般放 .h 中，重要说明放在 .cpp 中
参考doxygen使用说明附件带一示例，可下载用工具生成html，看下结果