浅谈C语言中的注释风格小结

C语言中常用的注释风格有两种，一种是通过如下模式进行一段代码的注释：

/* comment*/

另一种是单行注释符号：

// comment

学生时代的注释我一般是选用后者，那时候编码量十分有限，即使是简单的小段落注释使用的IDE也支持批量添加单行注释符。而在编码之中，简单的单行注释进行注释的时候键盘的操作更为简单一点。

不过，工作之后接触了相应的编码规范之后，C语言的注释我基本上放弃了单行注释的方法，最多仅仅在调试的时候做简单的使用。

其实，单行注释是从C++中借鉴来的，算是C++风格的注释方式。而这种方式在C语言中有时候会带来一定的差异性，甚至是引入难以察觉的Bug。把我自己从网络或者书籍中看到的两个比较典型的方式列述总结一下。

示例1：

#include"stdio.h"

int main(void)
{
    int a = 0;

    a += 5; \
    a = 123;

    printf("value of a: %d\n",a);

    return 0;
}

代码的编译运行结果如下：

E:\WorkSpace\01_编程语言\01_C语言\exp_26>gcc exp_26.c

E:\WorkSpace\01_编程语言\01_C语言\exp_26>a

value of a: 123

代码其实很简单，第一次对a进行的数值修改其实是一个没用的冗余代码。如果发现类似的问题，可能进行一下简单的屏蔽，修改代码如下：

#include"stdio.h"

int main(void)
{
    int a = 0;

    //a += 5; \
    a = 123;

    printf("value of a: %d\n",a);

    return 0;
}

代码的编译运行结果如下：

E:\WorkSpace\01_编程语言\01_C语言\exp_26>gcc exp_26.c

E:\WorkSpace\01_编程语言\01_C语言\exp_26>a

value of a: 0

这个结果很多时候会出乎很多人的意料，因为发现结果居然不再是123！其实，原因就在于屏蔽的那一行代码最后面多了一个续行的符号。这样使得注释的作用持续到了下一行。其实，很多编译器在这方面都会有相对精准的判断给出提示，比如说我最近在使用的VIM就能够通过颜色的变化提示出第二行也被注释掉了。而擅长语义分析的Source Insight在这方面倒是没有做好，不知道最新推出的V4版本中是否对此有所改进。

示例2：

#include"stdio.h"

int main(void)
{
    int a = 123;
    int b = 23;
    int c;

    c = a //*
           //*/b
    ;

    printf("value of c:%d",c);

    return 0;
}

从《C专家编程》中摘出了这个例子，按照书中的介绍，c的赋值运算相关3行在C语言中表示a/b而在C++中表示a。不过，或许是成书时间比较早，自我我的机器以及软件上，这个说法显然是不成立了。即使是咋C语言中，上面的表达式也是表示c = a。不过，程序的可读性确实是给了我们一个不小的挑战。我专门注意了一下编辑器对此的识别，在此环节中，VIM以及Source Insight全都识别准确。值得一提的是，前面的这两个例子如果使用NotePad ++，编辑器的提示也全都是准确的。

代码的编译执行结果如下：

E:\WorkSpace\01_编程语言\01_C语言\exp_27>gcc exp_27.c

E:\WorkSpace\01_编程语言\01_C语言\exp_27>a

value of c:123

由此看来，很多嵌入式的编码规范中要求不能够用C++单行注释风格的注释方式还是有一定道理的。虽说是带来了一定的不方便，但是确实是能够避免一些小问题的出现。

以上这篇浅谈C语言中的注释风格小结就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持我们。

赞 (0)

相关推荐

  • 实现去除c语言注释的小工具

    去除C代码中的注释,1. 单行注释//:2. 多行注释/**/:3. 单行注释以"\"结尾则下一行也为注释:4. 字符串中的注释不处理.说是C语言,但其实所有C语系的都可以,比如Java. 小工具:去除C语言注释  复制代码 代码如下: #include <stdio.h> int main(int argc, char* argv[]) {  enum {    literal,    single,    multiple,    string  } mode = li

  • 浅谈C语言中的注释风格小结

    C语言中常用的注释风格有两种,一种是通过如下模式进行一段代码的注释: /* comment*/ 另一种是单行注释符号: // comment 学生时代的注释我一般是选用后者,那时候编码量十分有限,即使是简单的小段落注释使用的IDE也支持批量添加单行注释符.而在编码之中,简单的单行注释进行注释的时候键盘的操作更为简单一点. 不过,工作之后接触了相应的编码规范之后,C语言的注释我基本上放弃了单行注释的方法,最多仅仅在调试的时候做简单的使用. 其实,单行注释是从C++中借鉴来的,算是C++风格的注释方

  • 浅谈Go语言中的结构体struct & 接口Interface & 反射

    结构体struct struct 用来自定义复杂数据结构,可以包含多个字段(属性),可以嵌套: go中的struct类型理解为类,可以定义方法,和函数定义有些许区别: struct类型是值类型. struct定义 type User struct { Name string Age int32 mess string } var user User var user1 *User = &User{} var user2 *User = new(User) struct使用 下面示例中user1和

  • 浅谈c语言中一种典型的排列组合算法

    浅谈c语言中一种典型的排列组合算法

    c语言中的全排列算法和组合数算法在实际问题中应用非常之广,但算法有许许多多,而我个人认为方法不必记太多,最好只记熟一种即可,一招鲜亦可吃遍天 全排列: #include<stdio.h> void swap(int *p1,int *p2) { int t=*p1; *p1=*p2; *p2=t; } void permutation(int a[],int index,int size) { if(index==size) { for(int i=0;i<size;i++) print

  • 浅谈c语言中类型隐性转换的坑

    谨记:在C语言中,当两种不同类型之间运算时,低字节长度类型会向高自己长度类型转换,有符号会向无符号类型转换. 举例子如下: #include <stdio.h> void func(void) { int i = 1; unsigned char c1 = 1; signed char c2 = -1; if (c2 > i){ printf("\r\n -1 > 1"); } else{ printf("\r\n -1 <= 1");

  • 浅谈c语言中转义字符的用法及注意事项

    c语言中的转义字符: \a 响铃符 \b 退格 \f 换页符 \n 换行符 \r 回车符(回到该行的首位置) \v 纵向制表符 \\ 反斜杠 \? 问号(?经vs10测试可以直接打印) \"(\') 双引号(单引号) \ooo 八进制数(ooo表示一个用8进制数表示出来的对应ANSII代码对应出字符,用此方法可以表示出所有ASCII字符.不过测试发现打不出%号,存疑!) \xhh 十六进制数(功能同八进制数,用hh表示一个十六进制数,如\x20表示空格) 注:使用转义字符的退格符,换行符,回车符

  • 浅谈Go语言中的次方用法

    浅谈Go语言中的次方用法

    Go语言中符号 " ^ " 不再用于次方,而是表示"按位异或的运算" 具体的运算规则如下: 按位异或 ^ : 两位一个为 0, 一个为 1 ,结果为 1 ,否则为 0(位表示二进制的机器码) 例子如下: 所以Go语言中2^3 = 1 不是 8(注意:计算机都是按照补码进行运算) 那么Go语言中的次方是什么:(下图所示) (官方文档是个好帮手) 补充:leetcode golang实现一个数的整数次方 pow(x, n) 我就废话不多说了,大家还是直接看代码吧~ pa

  • 浅谈Go语言中字符串和数组

    go语言里边的字符串处理和PHP还有java 的处理是不一样的,首先申明字符串和修改字符串 复制代码 代码如下: package main import "fmt" var name string           //申明一个字符串 var emptyname string = "" //申明一个空字符串 func main() {  //申明多个字符串并且赋值  a, b, v := "hello", "word", &

  • 浅谈C语言中的强符号、弱符号、强引用和弱引用

    首先我表示很悲剧,在看<程序员的自我修养--链接.装载与库>之前我竟不知道C有强符号.弱符号.强引用和弱引用.在看到3.5.5节弱符号和强符号时,我感觉有些困惑,所以写下此篇,希望能和同样感觉的朋友交流也希望高人指点. 首先我们看一下书中关于它们的定义. 引入场景:(1)文件A中定义并初始化变量i(int i = 1), 文件B中定义并初始化变量i(int i = 2).编译链接A.B时会报错b.o:(.data+0x0): multiple definition of `i':a.o:(.d

  • 浅谈C语言中结构体的初始化

    <代码大全>建议在变量定义的时候进行初始化,但是很多人,特别是新人对结构体或者结构体数组定义是一般不会初始化,或者不知道怎么初始化.1.初始化 复制代码 代码如下: typedef struct _TEST_T {        int i;        char c[10];}TEST_T;TEST_T gst  = {1, "12345"};//可以初始化,设置i为1,s为一个字符串.TEST_T gst  = {1};//初始化个数少于实际个数时,只初始化前面的成员

  • 浅谈Go1.18中的泛型编程

    浅谈Go1.18中的泛型编程

    目录 前言 以前的Go泛型 泛型是什么 Go的泛型 泛型函数 泛型类型 类型集合 和接口的差异 总结 前言 经过这几年的千呼万唤,简洁的Go语言终于在1.18版本迎来泛型编程.作为一门已经有了14年历史的强类型语言,很难相信它到现在才开始有一个正式的泛型. 以前的Go泛型 虽然直到1.18版本才加入泛型,但是在2014年便有相关的讨论要在Go中加入泛型设计.但是由于各种原因没有实现.而之后的接口(interface)的提出,让泛型进一步搁置.但是由于接口的缺陷,最终Go团队还是在1.18的版本中

随机推荐