学习用doxygen生成源码文档

作者佚名技术来源程序设计浏览发布时间 2012-06-29

o look for global variables, enums, functions
and macro definitions
*/
/** \var const int fileSize
\brief Default size of the file on disk
*/
const int fileSize = 1048576;
/** \def SHIFT(value, length)
\brief Left shift value by length in bits
*/
#define SHIFT(value, length) ((value) << (length))
/** \fn bool check_for_io_errors(FILE* fp)
\brief Checks if a file is corrupted or not
\param fp Pointer to an already opened file
\warning Not thread safe!
*/
bool check_for_io_errors(FILE* fp);

下面是生成的文档：

Defines #define SHIFT (value, length)　 ((value) << (length)) 　　　　　　 Left shift value by length in bits. Functions bool check_for_io_errors (FILE *fp) 　　　　Checks if a file is corrupted or not. Variables const int fileSize = 1048576; Function Documentation bool check_for_io_errors (FILE* fp) Checks if a file is corrupted or not. Parameters 　　　　　　　fp: Pointer to an already opened file Warning Not thread safe!

结束语

本文讨论如何用 doxygen 从遗留的C/C++ 代码提取出大量相关信息。如果用doxygen 标记生成代码文档， doxygen 会以容易阅读的格式生成输出。只要以适当的方式使用，doxygen 就可以帮助任何开发人员维护和管理遗留系统。

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!

上一页 1 2 3 4 5

分享到：更多

你可能对下面的文章感兴趣

上一篇: COM原理及应用---- 结构化存储下一篇: COM原理及应用----自动化（Automation）对象

关于学习用doxygen生成源码文档的所有评论

随机推荐