文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

C语言中注释与注意事项的深入讲解

2024-04-02 19:55

关注

C语言注释简介:

注释应该出现在三种位置

对于文件头部的注释至少列出:

函数头部注释要求至少列出:

C语言注释实例

注释在预编译阶段就会被删除掉,但是这里的删除并不是字面意义的删除,而是被替换,注释被替换,本质是替换成空格。

以下面的代码为例:


#include <stdio.h> 
int main() 
{ 
int  i; //正确 
char *s = "abcdefgh   //hijklmn"; //正确 
//Is it a\
  valid comment? //正确 
int j; //报错 
return 0; 
}

由于被替换成了空格,所以in t j这句话是无法编译的。

如果是C语言风格的注释出现了嵌套,则匹配,第二个匹配,代码会剩下一个*/:

注释的一些注意事项

  1. 注释应当准确、易懂,反之有二义性。错误的注释容易产生误导,不利于代码维护。
  2. 边写代码边修改注释,修改代码的同时要修改对应的注释,保证注释和代码的一致性。不再有用的注释要及时删除。
  3. 注释是对代码的“提示”,所以注释应当简单明了,因为注释太多会让人眼花缭乱。
  4. 对于全局数据(全局变量、常量定义等)必须要加注释。注释清楚定义全局数据的目的。
  5. 注释的位置应该与被描述的代码相邻,可以与语句在同一行,也可以在语句的上一行,但不能在语句的下一行,因为这样不符合人的阅读习惯。
  6. 当代码比较长,特别是有多重嵌套时,应当在一些段落结束时加注释,便于阅读。
  7. 注释的缩进要与代码的缩进一致,这样代码会更美观,可读性强。
  8. 注释代码段时应当注重“为何做”而不是“怎么做”,要说明这段代码的操作意图。
  9. 数值的单位一定要注释。
  10. 对变量的范围给出注释,特别是参数。
  11. 对一系列的数字编号给出注释,尤其是在编写底层驱动的程序。
  12. 避免在一行代码或表达式的中间插入注释。
  13. 复杂的函数中,在分支语句、循环语句结束之后需要加注释,方便区分各分支或循环体。

总结

到此这篇关于C语言中注释与注意事项的文章就介绍到这了,更多相关C语言注释与注意事项内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     801人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     348人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     311人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     432人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     220人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯