C语言编程规范

一、程序编写

每个编程都有自己的编程习惯,当因为编程习惯导致自己编写的代码其他人难以读懂或者理解,尽管自己已经把功能实现了,还是容易被其他人认为编程不规范,编程水平低下。对此,特定总结一下常用的一些编程注意事项,以方便他人阅读。

以上代码是之前编写的代码,关于该代码需要注意的事项如下:

1、宏定义变量尽量用全大写,除非是替代函数,可以采用全小写;

2、注释最好采用英文注释,像keil这样的编程软件,使用中文后,代码复制时,注释会出现乱码,对其他人理解产生阻碍;

3、函数或变量命名最好都采用小写,因为大小写区分在编程时需要切换,影响编程效率;

4、文件之间的数据传递,尽量都采用函数返回进行传递,单单个文件中必须要用全局变量时,应采用Static进行修饰,使得该变量其他文件无法调用;

5、对于其他文件用不到的函数,也采用Static修饰;

6、函数与函数之间应空一行,作为函数之间的分界线;

7、如对函数进行说明,通常采用多行的形式,内容一般包括,函数功能,输入参数,返回值等;

8、多行注释应采用/*...*/的形式;

关于格式还有以下几点需要注意:

10、一行代码通常不允许出现多条语句,会降低代码的可读性和美观性;

11、大小括号都要成对出现;

12、大括号要独占一格,并且层次对其,个人通常用Tab;

13、变量名称通常采用小写,且不能以单个字母作为变量名称,除了i,j,k,单词太多可用下划线隔开;

14、函数命名,最好统一采用英文单词,因为拼音可能被人错误理解;

15、函数的复杂度不要太高,否则可读性较差,一般在100行以内;

二、上传下载需要注意的地方

1、代码上传改动地方需要进行说明;

2、软件版本更替,通常由一个字母和数字组成,如V1.6.2,V是版本的简称,可要可不要,“1”为大版本号,通常是重大发布,“6”为功能号,当前大版本号不变的情况下,每增加一个新功能都会加1,“2”修复bug,该大版本修复一次bug,自动加1;

3、需要考虑变量是否写死,如将变量用constant修饰,将无法修改,那么一旦出现问题,需要重新编程,提交代码,经过测试审核等等一系列流程;

4、代码中最好不要用数字作为判断依据,否则很难理解,最好是采用,定义常数的形式进行编辑,方便阅读;

以上内容为之前编程过程中,或多或少遇到过的问题。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值