应用C语言代码风格检查

代码风格(style)一直是一个见仁见智的问题,但是对于一个团队而言,如果能在代码风格上达成一致,显然无论对团队还是对个人来讲都是大有裨益的。

在这方面我们也曾做过努力,包括在团队中引入astyle工具,并在astyle的代码美化风格配置上,团队成员也集体达成过一致。但是在开发过程中还是出现了一些问题。最主要的就是对astyle工具使用不足:一些同事总是记得不停地写代码,但却忘记了按约定好的风格要求写代码或按照要求通过工具执行代码美化。

为了尽可能地保证提交到代码库中的代码都是风格良好的(也可以在代码评审时间接减少评审者提出有关代码风格问题而耗费的工作量),我们将代码风格检查加入到代码构建的关键流程中去,这样可以起到一个提醒大家注意代码风格的作用。与Java等语言相比,C语言的代码风格检查工具相对较少且工具的功能也很有限。我Google了半天才找到一款简单且实用的工具-c_style_check.py。这个检查脚本使用正则式匹配的方法按照你制定的规则对源码文件进行校验,如果发现不符合规则的代码行,则给出提示。另外考虑到我们内部的要求,我对这个脚本也作了一些改造,增加了一些校验规则,并把最新的脚本放到了这里

目前的脚本较为简单,无法检查你的所有风格要求,不过它还是能检查出一些我们想要的不符合风格的地方。比如:不允许使用TAB字符、每行最大长度限制、在常见操作符(比如+,-,*,/,>,<等)两侧要添加空格、在){之间要求添加一个空格以及要求采用C传统注释方式等等。

另外,Google提供了一个强大的按照Google C++风格进行检查的代码检查器 – cpplint.py。不过尚没有C代码风格检查工具推出,不过cpplint.py这种级别的检查器是我们努力的方向。后续也许会逐步改进c_style_check.py

使用正确的算法和数据结构

本文翻译自”Use the Right Algorithm and Data Structure“,来自于《程序员应该知道的97件事》一书中的某个章节。

一家拥有多个分行的大银行抱怨说他们为出纳员新买的计算机运行得太慢了。这件事儿发生在电子银行以及ATM机使用普及程度远不及现在的那个年代。人们更多的是亲自到银行办理业务,这些运行超慢的计算机使得大家排起了长队。因此,这家银行威胁计算机供货商要结束他们之间的供货合同。

计算机供货商派出了一个性能分析和调优专家查找计算机运行缓慢的原因。这个专家很快就发现了一个运行在终端的特定程序几乎消耗掉了CPU的所有处理能力。他使用了一个程序分析工具将程序展开,并找到了那个导致计算机运行缓慢的罪魁祸首。其源码如下:

for (i = 0; i < strlen(s); ++i) {

    if (… s[i] …) …

}

这里的字符串s的平均长度有上千个字符。这段代码(由这个银行编写的)很快被修正了,并且这家银行的出纳员自从那以后工作得很开心…

难道程序员不应该做得更好一些并且不去使用那些无用的二次阶复杂度算法吗?

每次strlen调用都会遍历字符串中上千个字符里的每个字符以找到字符串的结尾null字符。不过,这个字符串永远不会改变。如果事先得到该字符串的长度,这个程序员本可以节省数千次对strlen的调用(以及数百万次循环的执行):

n = strlen(s);

for (i = 0; i < n; ++i) {

    if (… s[i] …) …

}

每个人都知道这句格言:“首先使其能工作,然后再考虑让其更高效地工作”,这可以避免微小优化导致的缺陷。不过上面的例子几乎可以让你相信这个程序员遵循的是权谋家的节拍“首先使其缓慢地工作”。

这种草率的事情你可能不止遇到过一次。这不仅仅是一件“不要重新发明轮子”的事情。有些时候新手程序员在没有仔细考虑的前提下就开始写代码,然后突然意外地“发明”了冒泡排序。他们甚至可能为其自夸一番。

选择正确算法的另外一方面是数据结构的选择。这会导致很大的差异:用一个链表表示你要搜索的一个具有百万项元素的集合-与用一个哈希数据结构或一个二叉树相比-这会对用户对你的编程能力的评价产生较大影响。

程序员不应该重新发明轮子,并且应该尽可能地使用现有的库。但是为了能避免类似上面银行发生的问题,他们应该进行一些有关算法以及算法规模评估的培训。难道这只是现代文本编辑器中的华而不实才使得他们运行起来就像是上世纪80年代的老程序一样缓慢吗,比如WordStar?许多人说编程中的重用是最为重要的。不过,最重要的是,程序员应该知道何时重用、重用什么以及如何重用。为了做到这些,他们必须拥有问题域以及算法和数据结构的知识。

一个优秀的程序员也应该知道何时使用一个性能较差的算法。比如,如果问题域规定永远不会多于五个元素(就像是在掷骰子游戏中骰子的个数),你知道始终最多对5个元素进行排序。在这种情况下,冒泡排序实际上也许才是进行排序的最高效的方式。每个人都有得意的那天。

所以,阅读一些好书 – 并且确保你理解了书中所讲的内容。如果你真地读过Donald Knuth的“计算机编程艺术”,你也许甚至很幸运:找到一处作者犯下的错误都可以得到Donald Knuth的面额为2.56美元的支票。

By JC van Winkel

 

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats