关于C语言|你可以这样来让代码看起来更舒服

  • 2017-12-26
  • 513
  • 0

 前言

虽然本人能力一般水平有限,但为了广大帮(女)同学改代码的程序猿的(精神)健康,就在这教大家一些增强代码可读性的技巧。这些方法同样会帮助你在review代码的时候知道你那个时候想了些什么。

关键词:命名法、注释、格式化

 

 

 

1关于变量/函数命名

 

想当初,老师讲第一节关于变量的课的时候,i,j,a,b什么的用的可爽了,可是到了现在你会发现,做一次作业光是变量名都记不住哪个是干什么的,比如这种:

关于C语言|你可以这样来让代码看起来更舒服

 

现在看着还比较轻松,但是如果需要传入函数,或者输入输出,或者什么其他的操作连在一起的时候,那就是噩梦了…

为了改进这个问题,向大家介绍一下一个比较通用的命名规范:骆驼命名法(驼峰命名法),此处给出的示例是“小骆驼法”

 

骆驼式命名法就是当变量名或函式名是由一个或多个单词连结在一起,而构成的唯一识别字时,第一个单词以小写字母开始;第二个单词的首字母大写或每一个单词的首字母都采用大写字母,例如:myFirstName、myLastName,这样的变量名看上去就像骆驼峰一样此起彼伏,故得名。

——百度百科

 

修改一下代码,你会发现基本可以直接读出变量/函数的用途:

关于C语言|你可以这样来让代码看起来更舒服

可以看出这个函数是“数组最大数据(float型)”

 

不要觉得这样命名之后,变量名/函数名太长在之后的操作中不方便使用,因为几乎所有IDE都有自动补全功能:

关于C语言|你可以这样来让代码看起来更舒服

Demo:在使用Atom和GCC配置环境下自动补全功能

 

最后,尤其尤其提醒一点,如果英文用不好的话,请尽量用简单的词汇,如果你非要用拼音的话。。请参考下面一节的内容继续提高可读性

 

2关于注释

 

关于注释应该写多少,怎么写,主要可以分为这么三种情况:

1. 能写注释的地方都写上注释

2. 只在必要的地方写注释

3. 把代码写到直接能读出干了什么,不需要写注释

然而很不幸,很多时候我看到身边的同学们都是第四种情况:

4. 不管代码写得能不能直接读明白,都不写注释

有的人会说,我的函数明明就是能看出来作用的,写注释干嘛!然后丢给我这样一个函数:

关于C语言|你可以这样来让代码看起来更舒服

这个函数名。。。好像是个拼音。。最高峰是什么鬼?

然后我继续看下面的内容,原来她想表达的是最高分。。。好吧,那么这样的话,请你先把zuigaofeng这个带着口音的变量名改成maxScore之类的再跟我谈可读性吧,要是非要这样命名,请一定写成这样关于C语言|你可以这样来让代码看起来更舒服

 

关于C语言|你可以这样来让代码看起来更舒服

 

对于大多数初学者来说,因为存在不熟练或者思路不完整的情况,所以建议大家在定义函数的时候加上说明,有的时候也可以在实现某一功能的代码段前面加上注释:

 

关于C语言|你可以这样来让代码看起来更舒服

代码是用C++写的,关注注释内容就好

 

 

3代码格式化的问题


C语言中括号(( )、[ ]、{ })的使用也是经常出问题的一点,比如函数里结尾的时候,如果遇到前面有for、if等,可能会出现两三个大括号结尾,如果括号没有一一对应,就可能编译不过或者实现不了想要的功能。此外,如果你有一个良好的格式化代码的习惯,自己debug和给别人看的时候都会愉快很多。

下面来介绍一下我习惯的几种格式化代码的情况:

关于C语言|你可以这样来让代码看起来更舒服
3.1
遇到大括号另起一行,并且下一行缩进一格(tab)

 

遇到for、if、while等带有大括号时,把大括号单独放在一行里,然后在下面一行缩进一格,我比较习惯用tab键缩进,空格也可以,看个人喜好:

 

关于C语言|你可以这样来让代码看起来更舒服

格式化前

 

关于C语言|你可以这样来让代码看起来更舒服

格式化后


 

关于C语言|你可以这样来让代码看起来更舒服
3.2
遇到 if 后不管有几行语句都先大个大括号上去

 

这样做是为了避免之后添加内容之后逻辑不清,同时也方便阅读:

 

关于C语言|你可以这样来让代码看起来更舒服

一行也加上大括号

 

另外就是在使用switch-case语句的时候,case:后也推荐加上大括号(虽然加和不加在大部分编译器上都没有区别),也是起到同样的效果。

 


 

关于C语言|你可以这样来让代码看起来更舒服
3.3
每个函数/功能之间加一行空格

 

程序里有很多个函数,或者一段程序里有多个功能块,在这些中间加一行空格,或者加一行注释,能使代码看起来更清晰:

关于C语言|你可以这样来让代码看起来更舒服

其实这一行留空看着更舒服些 关于C语言|你可以这样来让代码看起来更舒服


 

写在最后  
本期的内容就是这么多,关于C/C++你还有更多想知道的,可以在下面留言,下期可能就会写到的哦。

顺便说一下,网站的读者注册功能已经开启了(虽然鸡肋),注册并登陆之后可以在下面评论。

 

 

 

感谢打赏!
微信
支付宝

评论

还没有任何评论,你来说两句吧