流程1、核对源注释,检查语义是否仍正确,修改用object-c代码写的注释。
2、添加原来没有的注释
3、生成doxygen文档,检查格式是否正确,修改不正确的地方。
4、对于未实现的函数,保留注释,不出现在文档。例子1、对实现文件使用C/C++注释,要求写明主要的流程、算法,注释符后要留一个空格。
2、头文件使用Docxygen风格编写注释,要求写明使用方法,注意要点,dox[
阅读全文]
下面是我个人认为比较常用的标记:@author作者
@brief摘要
@version版本号
@date日期
@file文件名,可以默认为空,DoxyGen会自己加
@class类名
@param函数参数
@return函数返回值描述
@exce...[
阅读全文]
Doxygen心得技术2008-10-0816:24:54阅读2524评论0字号:大中小订阅几年前,看过几个开源项目的文档,发现每个开源都会有一个帮助文件,感觉注释非常详细。当时就感慨开源项目的人精力充沛。后发觉注释和代码有很多相似之处,经过研究,了解到了doxygen。正巧前段时间公司要程序生成文档,以前很多都是都是手工完成的。经过交流,我们修改了部分源代码的注释,同时我写一个[
阅读全文]
学习用doxygen生成源码文档ArpanSen,资深工程师,StudioBProductionsArpanSen是一位资深工程师,从事电子设计自动化行业的软件开发。他花了好几年研究多种风格的UNIX,包括Solaris、SunOS、HP-UX和IRIX,以及Linux和MicrosoftWindows。他主要对软件性能优化技术、图形理论和并行计算感兴趣。Arpan拥有软件系统研究生学位。简介:维护用C/C++开发的遗留系统并添加新特性是一项艰难的任务。幸运的[
阅读全文]
使用doxygen撰文/K.Young翻译/马维达(已发表在《程序员》2002年第3期上)一、介绍GLAST软件已采用doxygen(GNUGPL软件)来作为文档工具,本文将对其进行简单的介绍。要了解更详细的信息及下载doxygen程序,请访问网站http://www.stack.nl/~dimitri/doxygen/。什么是doxygen呢?下面的介绍录自doxygen的网页:“doxygen是一种用于C++、IDL(Corba、Microsoft和KDE-2DCOP风格)和C的文档系统。它可以通过三种[
阅读全文]
来源:http://hi.baidu.com/zkheartboy/blog/item/8ed283cae6a06c80c8176858.htmldoxygen使用详解2008-10-0513:42为代码写注释一直是大多数程序员有些困扰的事情。当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法,但对哪些地方应该写注释,注释如何写,写多少等这些问题,很多程序员仍然没有答案。更头痛的是写文档,以及维护文档的问题,开发人员通常可以忍受编写或者[
阅读全文]
程序文档,曾经是程序员的一个头痛问题。写一个程序文档,比较花时间,但不是很难;麻烦的是当程序修改后,程序文档也要跟着同步更新,否则文档和程序就要脱节,文档也就变成没用的东西了。
好在有许多好用的文档生成器来解决这个问题。目前比较流行的C++文档生成器是doxygen。
本文就简单的介绍一下doxygen的文档注释方法,以供初学者参考:
C++程序文档生成[
阅读全文]