程序编程规范——程序版式和变量命名规则

1. 为什么要重视程序编程规范?
我们知道只要程序逻辑正确,没有语法错误,程序书写规范的好坏并不会影响程序的占用内存和执行时间。那我们为什么还要注意程序的规范问题?让我们从两方面思考:
第一,“损人”:如果我们正在阅读别人书写的毫无注释,命名毫无规则的程序,这无疑是一件让头头疼的事,我们不得不靠自己推敲程序中函数之间,变量之间的逻辑,有时候的工作量不亚于自己编写一遍。
第二,“不利己”:我们有时候不得不回头看自己几个月之前写好的程序,令人惊讶的是,很多语句我们自己都不知道是干什么用的。以我自己为例,我就是在看自己以前书写代码时倍感困难才决定好好终结一套属于自己的程序编程规范,现在分享给大家,希望给大家提供一点帮助。
我所总结的程序编程规范主要分程序版式和命名规则两部分。本文将分别介绍程序版式和命名规则。


2. 程序编程规范——程序版式
2.1 空行和代码行
空行起着分割程序段落的作用,逻辑上密切相关的语句之间不加空行,其他地方应加空行分割。
每行代码只执行一条语句,这样代码容易注释和阅读。
2.2 代码行内的空格
代码行内的‘,’之后要留空格,如果‘;’不是一行的结束符号,其后也要留一个空格。
代码行内的赋值操作符、比较操作符、算数操作符、逻辑操作符、位域操作符等二元操作符的前后应当加空格。
代码行内的一元操作符等前后不加空格。
对于代码行内表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格。
对于代码行内过长的表达式要在低优先级出拆分成新行,操作符放在新行之首。
2.3 注释
注释通常用于:函数接口说明,重要代码行或段落提示。
如果代码本来就是清楚的,则不必加注释。
注释的位置应与被描述的代码相邻,可以放在代码的上方或者右方。
当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。


3. 程序编程规范——命名规则
目前我接触比较流行的命名规则有匈牙利命名法,和驼峰命名法,有想了解的朋友直接百度就可以了。我自己用的大部分根据驼峰命名法,借鉴了一部分匈牙利的,规则如下:
标识符应当直观且可以拼读,最好采用英文单词或其组合。
标识符的长度应当适度。
变量的名字应当使用“名词”或者“形容词+名词”。
全局函数的名字应当使用“动词”或者“动词+名词”,类的成员函数应当只使用“动词”,被省略的名词就是对象本身。
静态变量加前缀s_,全局变量加前缀g_,类的数据成员加前缀m_。
命名规则尽量与所采用的操作系统或开发工具的风格保持一致。


4. 总结
在这里给大家道个歉,由于主要是对自己学习的总结,并没有对每个规则进行例子的说明,可能读起来有些枯燥。
还要指出我所总结出来规则都在林锐老师的《高质量C++/C编程指南》提及了(里面对每种规则都进行了详细的例子说明,有兴趣的同学可以直接去看资料的第二章和第三章),我总结出来的是自己平时编程主要用到的一些规范总结。
感谢花费时间阅读我文章的人,如果有任何意见或建议希望可以留言交流,谢谢。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值