0x00 C编程风格

原创 2015年11月19日 11:43:24

编程风格有着廉价的学习成本,但是我们常常会疏忽它。随着编程代码量及代码阅读量的增多,发现其实编程风格是相当重要的,一个好的编程风格,可以起到点睛之笔,锦上添花的效果。

编写代码时,首先我们应该考虑的是阅读者,而不是编码者。

对于C语言编程风格,我想给出下面这些建议。

  1. 文件名: 对于文件的命名常常是众多初学者头疼的问题,以及使别人头疼的问题。我们常常命名难,是因为我将太多的东西糅杂到一个文件中。而更好的做法是小而精,文件中代码不一定要大量,但是一定要精。小的东西方便阅读,修改,重用。文件的命名为了达到见名知意,我建议这样命名:使用英文,单词小写,单词之间用下划线分隔。尽量少使用缩写。

    list.c or dynamic_list.c
  2. 头文件: 尽量每一个.c文件配有一个.h头文件,头文件使用#define保护: <PROJ>_<PATH>_<NAME>_H_

    
    #ifndef HELLOWORLD_SRC_LIST_H_
    
    
    #define HELLOWORLD_SRC_LIST_H_
    
    ....
    
    #endif //HELLOWORLD_SRC_LIST_H_ 
    
  3. 宏定义: 单词大写,下划线分隔

    
    #define MAX_LEN 10
    
  4. 函数名: 单词小写,下划线分隔单词,使用主谓语的格式。函数实现的功能尽量功能单一。

    list_append();
  5. 变量: 避免关键字和保留字,连写,第一个单词首字母小写,其他字母首字母大写。声明时一定初始化。将变量声明到其使用的最近地方。注意全局变量,尽量少使用全局变量。

    int thisAmount = 0;
  6. 结构体&枚举&联合名: 首字母大写,多单词连着写

    struct DynListNode;
  7. Includes: include 的引用顺序如下

    
    #include <c_system_files>
    
    
    #include <your_proj_files>
    
  8. 注释: 文件说明,函数说明等等,在合理的地方使用注释,不要吝啬单词。代码应该优先考虑阅读者。

  9. 布局排版: 为了方便阅读,代码的排版也是一个不能忽视的问题,为了是代码更美观,我们得考虑缩进空白括号 等的使用

    1. 缩进使用空格替代,4个空格
    2. 操作符前后合理使用空格
    3. 函数体之间使用空行
    4. 表达式使用括号使逻辑更清晰,而不仅仅依赖优先级
版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

linux C编程风格

  • 2011年11月05日 14:23
  • 36KB
  • 下载

Object-C 声明属性为什么用下划线,代码规范和编程风格

Object-C 声明属性为什么用下划线,代码规范和编程风格   在阅读和书写关于iPhone编程的代码的时候,发现有很多这样的情况: 看到很多源代码里面,使用前面带下划线变量,然后在@sy...

Google C 编程风格指南

  • 2015年11月07日 22:16
  • 488KB
  • 下载

高质量Matlab及C及C++编程风格指南

  • 2011年12月05日 18:32
  • 844KB
  • 下载

C/C++良好编程风格

/*====================================================== * * 说明:记录自己曾经学习过的C/C++编程风格 * * 作者:xue 2...

找工作笔试面试那些事儿(1)---C,C++基础和编程风格(1)

作者:寒小阳 时间:2013年8月。 出处:http://blog.csdn.net/han_xiaoyang/article/details/10473845。 声明:版权所有,转载请注明出处...
  • liuuze5
  • liuuze5
  • 2015年10月28日 15:00
  • 288

Objective-C代码规范和编程风格参考

代码写的不够漂亮工整符合规范?大家的代码风格过于迥异阅读困难?   作为一个程序猿来说我越来越感觉到养成一个良好的代码风格的重要性,总结一下OC编程中的一些代码规范(苹果官方推荐的)。   参考资...
  • ixfly
  • ixfly
  • 2012年09月03日 16:56
  • 6292

转:从《The C Programming Language》中学到的那些编程风格和设计思想

读书不是目的,关键在于思考。 很早就在水木上看到有人推荐《The C Programming Language》这本书,一直都没看,开学一个月就专心拜读了一下,并认真做了课后习题。读...

理解C语言——从小菜到大神的晋级之路(15)——完结篇:C编程风格

本期视频链接:点击这里 有人说过:“程序源代码其实是跟人阅读的,只是恰好机器可以编译而已”。编程初学者常常会有这样一个观念,就是我的程序只要编译通过了,运行没有问题那就万事大吉了。至于代码的编写规不...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:0x00 C编程风格
举报原因:
原因补充:

(最多只允许输入30个字)