近期由于项目需要，参考网上资料整理了一下注释规范，详细内容如下：
1.&&&doxygen的安装与参数配置 1.1.&&安装 $ sudo apt-get install doxygen 以下可以选择安装 $sudo apt-get install doxygen-doc doxygen-gui graphviztexpower dot2tex graphviz-doc texpower-examples 1.2.&&生成配置文件 在 shell 提示上，输入命令 doxygen -g。这个命令在当前目录中生成一个可编辑的配置文件 Doxyfile。可以改变这个文件名，在这种情况下，应该调用 doxygen -g&user-specified file name& 1.3.&&修改配置参数 l&&&&&&&&&OUTPUT_DIRECTORY&：必须在这里提供一个目录名，例如 /home/user1/documentation，这个目录是放置生成的文档文件的位置。如果提供一个不存在的目录名，doxygen 会以这个名称创建具有适当用户权限的目录。 l&&&&&&&&&INPUT&：这个标记创建一个以空格分隔的所有目录的列表，这个列表包含需要生成文档的&C/C++&源代码文件和头文件。例如，请考虑以下代码片段：
INPUT = /home/user1/project/kernel /home/user1/project/memory
在这里，doxygen 会从这两个目录读取&C/C++&源代码。如果项目只有一个源代码根目录，其中有多个子目录，那么只需指定根目录并把&RECURSIVE&&标记设置为&Yes。 l&&&&&&&&&FILE_PATTERNS&：在默认情况下，doxygen会搜索具有典型&C/C++&扩展名的文件，比如&.c、.cc、.cpp、.h&和&.hpp。如果&FILE_PATTERNS&&标记没有相关联的值，doxygen就会这样做。如果源代码文件采用不同的命名约定，就应该相应地更新这个标记。例如，如果项目使用&.c86&作为&C&文件扩展名，就应该在&&FILE_PATTERNS&&标记中添加这个扩展名。 l&&&&&&&&&RECURSIVE&：如果源代码层次结构是嵌套的，而且需要为所有层次上的&C/C++&文件生成文档，就把这个标记设置为&Yes。例如，请考虑源代码根目录层次结构 /home/user1/project/kernel，其中有/home/user1/project/kernel/vmm 和/home/user1/project/kernel/asm 等子目录。如果这个标记设置为&Yes，doxygen 就会递归地搜索整个层次结构并提取信息。 l&&&&&&&&&EXTRACT_ALL&：这个标记告诉 doxygen，即使各个类或函数没有文档，也要提取信息。必须把这个标记设置为&Yes。 l&&&&&&&&&EXTRACT_PRIVATE&：把这个标记设置为&Yes。否则，文档不包含类的私有数据成员。 l&&&&&&&&&EXTRACT_STATIC&：把这个标记设置为&Yes。否则，文档不包含文件的静态成员（函数和变量）。 l&&&&&&&&&SOURCE_BROWSER&：把这个标记设置为&Yes，自动加入源码。 & & 2.&&&文件注释 2.1.&&示例 /** &*
apply.c &*
lishujie &*
1.0 &* @date
this brief &* @details this's details &*/ 2.2.&&说明 l&&&&&&&&“@file”后的文件名需与当前文件名一致 & 3.&&&结构体注释 3.1.&&简洁样例 typedef struct Mac_Config&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& the brief structcomment { &&&&&&&& charmacaddr[QCT_OTHER_MACADDR_64]; &&&&&&&&&&
///& The brief mement comment &&&&&&&& chardevicename[QCT_OTHER_DEVNAME_64];&&&&&&&&&///& The brief mement comment &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& The brief mement comment } Mac_ 3.2.&&详细样例 /** &* this is details struct &*/ typedef struct DynamicConfigT &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
///& The brief mementcomment { &&&&&&&& int&&&& nApplyId;&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& The brief mement comment &&&&&&&& int&&&& nT &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& The brief mement comment &&&&&&&& int&&&& nR &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& The brief mement comment & &&& /** this is details mement comment */ &&&&&&&& char**& aValT &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& The brief mement comment &&&&&&&& LocalHndl&& pfnH &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&///& The brief mement comment } DynamicC 3.3.&&说明 l&&&&&&&&“///”与注释间留有2个空格 l&&&&&&&&“///&”与注释间留有1个空格 l&&&&&&&&结构体成员的详细注释写在该成员上面 l&&&&&&&&结构体成员的详细注释与上一成员间留1个空行 l&&&&&&&&推荐结构体使用typedef类型定义 l&&&&&&&&推荐使用简洁的结构体注释 & 4.&&&枚举注释 4.1.&&样例 typedef enum _COLOR &&&&& ///& The brief enum comment { BLACK,&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
///& The brief member comment NAVY, &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
///& The brief member comment }COLOR; 4.2.&&说明 l&&&&&&&&与结构体的简洁注释相同 & 5.&&&宏注释 5.1.&&简洁样例 /// This macro is toolong, so comment here briefly! #define HTTP_REQUEST_LEN_MAX&&& APPLY_BUF_SIZE_BIG 5.2.&&详细样例 /** &* The detail macro comment, may be multi-line. &*
a The brief parameter comment &*
b The brief parameter comment &*
The brief return value comment &*/ #define MAX(a, b) ((a) & (b))? (a) : (b) 5.3.&&说明 l&&&&&&&&尽量少写宏函数，可以使用内联函数代替 l&&&&&&&&推荐使用简洁的宏注释 & 6.&&&函数注释 6.1.&&简洁样例 /// The brieffunction comment, may be multi-line.
static int apply_login(); 6.2.&&详细样例 /** &* The detail function comment, may bemulti-line. &*
cur_id The brief parameter comment &*
The brief return value comment &*
The brief function comment &*/ static int reboot_enable( intcur_id ) 6.3.&&说明 l&&&&&&&&简述以///+空格开头或使用 ，详述以/**开头 l&&&&&&&&无参无返回值的简单函数使用简洁注释 l&&&&&&&&头文件有声明的函数注释在头文件中；否则注释在代码文件中 & 7.&&&其它注释 l&&&&&&&&代码中其余注释一律使用普通的单行注释“//”和多行注释“/*”“*/”。 & 8.&&&附录 8.1.&&注释换行 Doxygen 会忽略你注释中的换行符，将多行注释连接成一个连续行并使用空格隔开。如 果你希望保留两行注释之间的换行，需要在该行末加入“/n”。 8.2.&&常用命令
生成字段名
链接到所有缺陷汇总的缺陷列表
代码块开始，与“nendcode”成对使用
代码块结束，与“ncode”成对使用
& 文件名& 文件参考
用在文件注释中
用在函数注释中
用在函数注释中
链接到所有TODO 汇总的TODO 列表
8.3.&&vim+Doxygen方便的写注释 8.3.1.&&&安装 下载 doxygen的 vim 插件 &&&http://www.vim.org/scripts/script.php?script_id=987 将下载的插件安装到$VIMRUNTIME/plugin目录下 在VIM的配置文件中(windows下的_vimrc，linux下的vimrc或者~/.vimrc)为doxygentoolkit这个插件配置一些全局变量： let g:doxygenToolkit_authorName=&your name& let g:doxygenToolkit_briefTag_funcName=&yes& 8.3.2.&&&常用命令 Dox DoxAuthor DoxLic 8.4.&&给source insight添加doxygen注释风格 请参考：http://blog.csdn.net/dayong419/article/details/7932467
参考资料如下： 学习用 doxygen 生成源码文档
/developerworks/cn/aix/library/au-learningdoxygen/#list2
CommentManual.pdf
.hk/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=0CCsQFjAA&url=%68%74%74%70%3a%2f%2f%67%65%74%69%6d%61%67%65%2e%67%6f%6f%67%6c%65%63%6f%64%65%2e%63%6f%6d%2f%66%69%6c%65%73%2f%43%6f%6d%6d%65%6e%74%4d%61%6e%75%61%6c%2e%70%64%66&ei=SF5HU66EPZe58gWl7IDIBA&usg=AFQjCNGATKOIt_-gTeszmuke-R7KbNCScQc++编程中的单行注释 与多行注释用？有什么区别？_百度知道
c++编程中的单行注释 与多行注释用？有什么区别？
什么情况下用单行，什么情况下用多行？
提问者采纳
ssddffdgfgfggdffffffsdfgf*&#47..，一行就用一行注释如单行的/XX函数多行的&#47.注释内容是多行就用多行注释;&#47
其他类似问题
为您推荐：
其他2条回答
只是多行注释能一次注释多行;&&#47，比较方便，如果有一个多行需要注释;&#47，你用单行注释的话只能每行都写&quot随便你怎么用
多行注释不能嵌套
您可能关注的推广回答者：
等待您来回答
下载知道APP
随时随地咨询
出门在外也不愁c++中一个求几个数中最大值和最小值的代码，求给我注释一下每行的意思_百度知道
c++中一个求几个数中最大值和最小值的代码，求给我注释一下每行的意思
& cout&p[min]) min=i;'&'n; cout&&lt:&quot:&&&for(i=1;&&n;&lt:&n;i&&&iostream&&lt,min=0;& &&所输入数中最大数为第,&i++) {cin&min+1&p[max]&个;int main(){所输入数中最小数为第;&;&i++) {if(p[i]&lt,&&&lt:&\个;&& cin&&lt,n;&lt,*p;'& &&p[min]&} cout&p[i];&&lt,max=0;最大数为; '&max+1&&p[max]) max=i; p=new int[n];} for(i=1:&请输入要输入数的个数;& for(int i=0;&:&&i&i++) {if(p[i]&i&请逐个输入数据; 'n'&&&n;} cout& delete[]p;&lt#include& return 0;最小数为;endl
提问者采纳
&/ &&&&&求最小数;i&lt:& 'p[i];&#47,min=0;最大数为;iostream&n''&quot，同理 {if(p[i]&所输入数中最小数为第;&#47,n;n,&i++)//'指针p指向数组的起始位置 for(int i=0;&&&&:&/&&} for(i=1;min+1&如果当前数比最大数要大的话就将max赋值为当前数的下标 cout& cin&& cout&n;/ delete[]p,*p;}/&个;/个;n;&p[max]&&头文件} cout&&;p[min]) min=i;i&&&/&'max+1&p[max]) max=i;&lt:&quot,max=0;/&int main()/&&&&i++)//p[min]&lt,&主函数{输出最大数的下标 &&&#47:&所输入数中最大数为第;n; p=new int[n];循环输入n个数 {cin&&&lt:&/&请输入要输入数的个数;&lt:&/i&/输入待比较的数的个数 cout&&\ '/最小数为;请逐个输入数据;输出最大数for(i=1;i++) {if(p[i]&/&lt#include&释放指针p return 0;&endl
提问者评价
其他类似问题
为您推荐：
等待您来回答
下载知道APP
随时随地咨询
出门在外也不愁谁能帮我看看 这个 求 质数的C++程序 是什么意思啊 数学的基础也不是很好 虽然有注释 可是还是没太明白_百度知道
谁能帮我看看 这个 求 质数的C++程序 是什么意思啊 数学的基础也不是很好 虽然有注释 可是还是没太明白
/ i&/ 后面的是注释&#47,5};/
if(found)/count of primes found int found=0;&MAX);/&#47大家帮帮忙吧 谢谢啦 下面是 源程序 C++代码 两个 \#include&if division is exact
/*(primes+i);indicates when a prime is found do
trial += 2;//first three primes defined long trial=5;setw(10)&iostream& i++) /\// /i++) {
if(i%5==0)
cout& output primes 5 to a line for (int i=0;candidate prime int count=3;/
cout&//we got one
*(primes+count++)=MAX;/it is not a prime
if (found==0)////number of prime required long primes[MAX]={2;/so save it in primes array }while(count&lt,3;next value for checking
found = 0;/i&/true for exact division
{found=(trial% *(primes+i))==0;&int main(){ const int MAX = 100; return 0;set found indicator
for(int i=0;iomanip&/& } cout&/calculating primes#include&/&lt
提问者采纳
看代码关键是看懂算法; i&lt，在2的上面画一个圆圈;true for exact division
found=(trial% *(primes+i))==0;&#47://&#47，表中画了圈的以及未划去的那些数正好就是小于 N的素数;&#47，就把trial里的值放到primes[count]中，则说明找到的是新素数
*(primes+count++)=trial：先将2－N的各数写在纸上;MAX)，他这里关键是看懂用的厄拉多塞筛选法求素数的。trial用于临时存放新找到的质数;it is not a prime
if (found==0)&#47，将它画圈，也就是found=(trial% *(primes+i))==0这一行;&#47： i++) &#47，作过渡用；现在既未画圈又没有被划去的第一个数 是5，=1表示不是质数 do
trial += 2，起始值已经列出了235三个数count是已经找到质数的数目;&#47，for(int i=0;if division is exact
count，代码里他用了指针表示，并划去5的其他倍数……依次类推;用新的尝试数来取余所有已经找到的素数;&#47，然后划去2的其他倍数，如果不明白见这里.com/question/，将它画圈，并把count自加1以便下一次存储使用.baidu；第一个既未画圈又没有被划去的数是3;/ i&lt，就只解释这个循环，初始值是3; i++)这一行就是遍历所有已经找到的素数的://zhidao，found等于取余结果
if(found)&#47，直接跳过偶数即可
found = 0.&#47。这时.com/question/代码的核心是do-while那个循环;/至于a=b==c这种表达式是什么意思，其它部分相信你也能看懂:*(primes+count++)found是标记;&#47
提问者评价
大家回答的 都很好 谢谢啦 分就给你吧 呵呵 谢谢啦 谢谢大家了
其他类似问题
为您推荐：
其他2条回答
#include&iostream&
#include&iomanip&
int main()
const int MAX = 100;//本程序准备找100个素数
long primes[MAX]={2,3,5};//前3个素数先找好了
long trial=5;//从5开始往后找
int count=3;//已经找到了3个素数，即2，3，5
int found=0;//在循环中表示是否找到一个素数，1表示不是素数
trial += 2;//从5开始，之后的素数肯定是奇数，所以每次加2，找奇数就行了
found = 0;//现设found为“还没找到素数”的状态
for(int i=0; i& i++) //当还没找到100个素数的时候，循环
{found=(trial% *(primes+i))==0;
//如果当前的奇数有质因子，说明不是素数。注意，这里和一般的找素数程序不同。一般的程序是从2到trial/2，或者2到sqrt(trial)来循环，这里是直...
质数的相关知识
等待您来回答
下载知道APP
随时随地咨询
出门在外也不愁