doxygen usage
来源:互联网 发布:疯狂联盟营地升级数据 编辑:程序博客网 时间:2024/06/11 21:12
Doxygen is good tool for literally programming. It shouldn't be only a set of standards to write comments, but a powerful tool to write agile documents (I insist that programmers should write documents to describe your idea, but I deny the meaningless documents). Sth to notes: 1. don't abuse the doxygen tags unless you decide the comments should become documents. 2. use dot 3. use verbatim to do more descriptions. 4. use the comments to describe what is the process of a function, eg. /*! * ... */ int f(int a) { /*! for each i between [0, 100): * */ for (int i = 0; i < 100; ++i) { /*! doing the calculation */ caculate(); } } Thus, doxygen can generate the documentation like: for each i between [0, 100): doing the caculation;
- doxygen usage
- Doxygen
- Doxygen
- Doxygen
- Doxygen
- doxygen
- doxygen
- doxygen
- Doxygen
- doxygen
- Doxygen
- usage
- Doxygen - Doxygen简介
- Doxygen - Doxygen简
- 使用doxygen
- Doxygen文档
- doxygen总结
- Doxygen簡介
- 什么是Windows服务,它的生命周期与标准的EXE程序有什么不同
- 学习struts和hibernate所用的层
- 声光报警
- 欢迎大家加入broncho社区与broncho共同发展
- jQuery技巧总结
- doxygen usage
- Hdu 1042 N!解题报告
- 计算机等级考前数据库训练259题(1)
- 一个项目的开发过程及成员组成
- SyntaxHighlighter google开源项目(语法高亮、代码着色) - 开源空间 - 共享社区共享空间 - Powered by Discuz!NT
- 新选择,新生活
- 软件中存在的技术风险
- chapter five
- Windows上的单个进程所能访问的最大内存量是多少?它与系统的最大虚拟内存一样吗?这对于系统设计有什么影响?