码迷,mamicode.com
首页 > 编程语言 > 详细

Windows客户端C/C++编程规范“建议”——前言

时间:2014-07-23 00:03:17      阅读:238      评论:0      收藏:0      [点我收藏+]

标签:style   blog   http   color   使用   strong   

前言

        工作中接触了很多编程规范。其中最有意思的是,公司最近发布了一版C/C++编程规范,然后我看到该规范的最后一段时,有这么一句:“该规范不适用于Windows平台开发”。看来这份规范是由做其他平台开发的同学制定的。那么做Windows开发的人都去哪儿了?后来由于工作需要,项目组需要我制定一份编程规范。这也是我这系列博客的由来。(转载请指明出于breaksoftware的csdn博客)

        说到“规范“”,可能没多少人喜欢这样的东西。相信很多工程师和我一样,都喜欢互联网的一些特质:自由、兼容并包。己所不欲勿施于人,所以我制定该“规范”时,也是抱着开放的态度——在”规范“之后加了”建议“二字。之后,我都会统称这些条例为“建议”。

        假如说指定“规范”是容易的(其实也不容易),那么最难的是让人遵从。一般如果我们想遵从什么,肯定要先想好我们为什么要遵从,我们遵从之有什么好处,可以给我们带来什么?同样我也是按着这个思维去制定这样的“建议”,我将会从代码的可读性、可维护性、健壮性等角度,思考和编制该“建议”。希望这些“建议”可以协助大家写出更易读、更健壮、更好看的代码。

        本“建议”条例分为以下若干等级:

【必须】

编码必须遵从。

【要求】

该规则可以非常好的提高易读性、高效性和安全性。在特殊情况下,可以不遵从,但是需要给出不遵从的理由。

【推荐】

该规则可以部分提高易读性、高效性和安全性。在大部分情况下,需要遵从。

【建议】

该规则只是作为建议,代码作者可以根据自己判断来决定。

        本“建议”中例子代码,使用不同底色表示代码是否存在问题:

        bubuko.com,布布扣表示代码存在问题。

        bubuko.com,布布扣表示一种可以修复存在问题代码的方式。

        本建议将分为以下若干模块。我会根据工作中新的发现和认识以及朋友们的建议,不定期更新这些条例。并将更新历史记录在该文的末尾,以便大家查阅。

        模块:

  1. 函数                     《Windows客户端C/C++编程规范“建议”——函数》
  2. 指针                     《Windows客户端C/C++编程规范“建议”——指针》 
  3. 函数调用             《Windows客户端C/C++编程规范“建议”——函数调用》
  4. 表达式和运算     《Windows客户端C/C++编程规范“建议”——表达式和运算》
  5. 结构                     《Windows客户端C/C++编程规范“建议”——结构》
  6. 宏                         《Windows客户端C/C++编程规范“建议”——宏》
  7. 文件                     《Windows客户端C/C++编程规范“建议”——文件》
  8. 变量和常量         《Windows客户端C/C++编程规范“建议”——变量和常量》
  9. 风格                     《Windows客户端C/C++编程规范“建议”——风格》

        更新历史:

时间 内容 备注
2014.07.18 录入“建议”各项 初稿


Windows客户端C/C++编程规范“建议”——前言,布布扣,bubuko.com

Windows客户端C/C++编程规范“建议”——前言

标签:style   blog   http   color   使用   strong   

原文地址:http://blog.csdn.net/breaksoftware/article/details/37928367

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!