C语言学习笔记 代码注释-10

目录

一、注释概述

二、注释类型

三、注释原则

四、注释建议

总结

---

一、注释概述

       对于一个新手来说，注释比较陌生，但是现实中它是比较常见的。例如，语文书本出现某些难以理解的文言文，下面就出现小字体的解释，相当于翻译，把别人难以理解的东西翻译为大家便于理解的东西。同理，在编程中，代码注释就是对代码的解释说明，主要是为了提高代码的可读性，方便大家阅读。

二、注释类型

1.单行注释：使用//作为界定符，//右边是注释的相关内容

例子：printf("hello world!\n");  //输出hello world!内容

2.多行注释：使用/* */作为界定符，/*作为注释内容的起始位置，*/作为注释内容的结束位置

例子：

/*

编写一个程序，定义一个整数，然后输入它的值。

*/

int a=1;

printf("a is %d!\n",a);

三、注释原则

1.注释要简洁明了；

2.在完整的开发项目中，代码注释应该保持规范与统一；

3.写代码的同时也要加上相应的注释，代码修改时注释也要同步修改；

4.注释可以放在任意地方，甚至是与代码同一行，但是要养成良好的注释风格；

四、注释建议

1.注释内容应以简洁明了为主，没有必要写那些繁杂难以理解的注释；

2.注释风格统一，使用//或/**/，不要经常变化；

3.不要在代码中间插入注释，除非必要，否则会降低代码的可以读性；

4.尽可能地描述代码的目的、程序设计的模块功能，为用户提供有用的信息；

5.注释内容应该避免重复。

总结

       整个注释的内容不多，但是很多程序员在写代码时在这一块上都不上心，导致后续程序员对现有代码的维护困难。建议形成个人的良好注释风格，写出来的代码不但是方便自己维护，也方便别人维护。还有，注释的方式有两种，没必要说一定要使用/**/这种，它只是一种工具，善于使用就好。好了，我们在下一个章节再见，加油！