c语言注释规范题,求代码和注释

第一章 程序设计和C语言 习题 - edwardflee的博客 - 编程中国
第一章 程序设计和C语言 习题
source programobject programexecutive program
Cmainmainmain
PrintfscanfC
******************************
Very &Good
******************************
/*时间:日15:24:46题目:习题1.5 请参照本章例题,编写一个C程序,输出以下信息*/# include &stdio.h&int main(){printf("******************************\n");printf("Very Good !\n");printf("******************************\n");return <SPAN style="COLOR: #;}/*在VC++6.0中的输出结果为:————————————******************************Very Good !******************************Press any key to continue————————————*/
1.6. &Cabc时间:日15:34:57题目:习题1-6 编写一个C程序,输入a、b、c三个值,输出其中最大者*/# include &stdio.h&int main(){&&&&int a,b,c;&&&&int&&&&int max (int x, int y);&&&&&&&&printf("Input 3 numbers\n");&&&&scanf("%d %d %d",&a,&b,&c);&&&&d = max(a,b);&&&&d = max(d,c);&&&&printf("The max is %d\n",d);&&&&return <SPAN style="COLOR: #;}int max (int x, int y){&&&&int&&&&if (x&y)&&&&{&&&&&&&&z =&&&&}&&&&else&&&&{&&&&&&&&z =&&&&}&&&&return (z);}/*在VC++6.0中的输出结果为:————————————Input 3 numbers5 8 2The max is 8Press any key to continue————————————*/
1.7 时间:日15:59:15题目:习题1.7 上机运行以下程序,注意注释的方法。分析运行结果,掌握注释的用法*/# include &stdio.h&int main(){&&&&printf("How do you do!\n");&&&&&&&&//这是行注释,注释范围从//起至换行符止&&&&&&&&printf("How do you do!\n");&&&&&&&&/*这是块注释*/&&&&printf("How do you do!\n");&&&&&&&&/*这是块注释,如在本行写不完,可在下一行继续写&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& 这部分内容均不产生目标代码*/&&&&//printf("How do you do!\n");&&&&//把这行语句作为注释,不执行&&&&printf("//How do you do!\n");&&&&//在输出的字符串中加入//&&&&&&&&/*printf("How do you do!\n");&&&&//用块注释符把几行语句都作为注释&&&&return 0;*/}/*在VC++6.0中的输出结果为:————————————How do you do!How do you do!How do you do!//How do you do!Press any key to continue————————————*/
浏览47397次
(9472)(5594)(5310)(3611)(3112)(1389)(1362)(931)(926)(919)C语言编程规范——注释篇_IT小咖2016_新浪博客
C语言编程规范——注释篇
一、关于Doxygen
&&&&Doxygen是一种开源跨平台,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java等语言,部分支持PHP、C#。
利用Doxygen可以将程序中的特定注释转换成为说明文件。同时,利用Doxygen也可以提取代码结构,自动生成包含依赖图、继承图以及协作图来可视化文档的关系,使得代码的可读性更强。&
二、关于注释的说明
注释的主要原则是有助于对程序的阅读理解,但注释不宜太多或太少,在需要注释的地方一定要加上,但在能够通过命名等能够体现编程意图的地方则不需要,力求注释准确、易懂、简洁,主要做到以下几点:
·避免对单独语句进行注释;
·通过注释解释为什么这么做、或者要做什么,使代码的读者可以只阅读注释理解代码;
·对读者可能会有疑问的地方进行注释;
·对数据定义进行注释,而不是对其使用过程进行注释;
·对于难于理解的代码,进行改写,而不要试图通过注释加以说明;
·对关键的控制结构进行注释;
·对数据和函数的边界、使用前提等进行注释;
·由于中文支持问题,注释尽可能都采用英文描述。
三、基于Doxygen格式的C语言注释
要想利用Doxygen生成对应的注释文档,那么就需要按照Doxygen的格式来注释代码。
&&&&首先对于一个项目而言,可能分成了很多个模块,那么就需要使用@defgroup来定义一个模块。
&定义模块&
当需要将某个文件加入到特定的模块,使用addtogroup
&#65279;添加到模块
模块定义执行完成之后,需要对文件进行相关的说明,在Doxygen下,使用\file或@file这样的方式来标注,参考如下:
&&#65279;文件头示例
对于不需要生成说明文档的注释按照以下格式即可:
对于对外提供的函数,需要使用doxygen生成注释的,需要按照以下格式对函数参数,返回值,用途等进行说明。
&#65279;函数格式
而对于不需要对外提供,仅仅在当前文件中使用的函数,需要使用static关键字,可进行简单注释即可。
static void&an_example_function(void)
对于结构体,共用体,枚举类型而言,按照以下格式注释:
&结构体注释
若按照以上格式进行注释,即可让编写的C代码更易读,同时也可以利用现有工具生成完整的说明文档。
IT小咖2016
博客等级:
博客积分:0
博客访问:3,515
关注人气:0
荣誉徽章:&&/&&&&/&&&&/&&
50个比较经典的C语言代码分享给大家,我都加了注释和解析。学习编程,只了解基本概念是不行的,关键是要写出高质量的代码,才能成为合格的农民(程序猿又叫码农,我一直称自己是农民^_^)。这些代码,能够加强你的练习,看看真正的农民是怎么种地的。
记住哦,不要觉得码农拿几十万的年薪不公平,想做农民,就要不断耕耘,一直一直敲代码,编程能力跟你的代码量绝对成正比。所以,请大家不要再问我,怎么学,学多久,我的答案就是不断写代码,写多了,棒槌也能开窍,做农民的都是这样过来的,没有捷径。
文章列表:}

我要回帖

更多关于 c语言注释规范 的文章

更多推荐

版权声明:文章内容来源于网络,版权归原作者所有,如有侵权请点击这里与我们联系,我们将及时删除。

点击添加站长微信