WindowsclientC/C++编程规范“建议”——前言

前言

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

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

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

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

【必须】

编码必须遵从。

【要求】

该规则能够很好的提高易读性、高效性和安全性。在特殊情况下,能够不遵从,可是须要给出不遵从的理由。

【推荐】

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

【建议】

该规则仅仅是作为建议,代码作者能够依据自己推断来决定。

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

WindowsclientC/C++编程规范“建议”——前言表示代码存在问题。

WindowsclientC/C++编程规范“建议”——前言表示一种能够修复存在问题代码的方式。

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

模块:

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

更新历史:

时间 内容 备注
2014.07.18 录入“建议”各项 初稿
上一篇:[PHP]算法-拼接最小字典序的实现


下一篇:微信开放平台 获取 component_verify_ticket