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

前言

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

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

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

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

【必须】	编码必须遵从。
【要求】	该规则可以非常好的提高易读性、高效性和安全性。在特殊情况下，可以不遵从，但是需要给出不遵从的理由。
【推荐】	该规则可以部分提高易读性、高效性和安全性。在大部分情况下，需要遵从。
【建议】	该规则只是作为建议，代码作者可以根据自己判断来决定。

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

表示代码存在问题。

表示一种可以修复存在问题代码的方式。

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

模块：

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

更新历史：

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

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

Windows客户端C/C++编程规范“建议”——风格
9 风格 9.1 优先使用匈牙利命名法等级: [推荐] 说明:该方法由微软总设计师设计.Windows上编程最好遵从该标准.详细介绍见:http://zh.wikipedia.org/wiki/%E ...
Windows客户端C/C++编程规范“建议”——宏
6 宏 6.1 减少宏的使用等级: [建议] 说明:宏的使用,将使得调试变得麻烦.所以在设计和使用宏的时候,请确保宏的逻辑是阅读者不会去关心细节的行为. 6.2 宏定义中字母需大写等级: [必须] ...
Windows客户端C/C++编程规范“建议”——结构
5 结构 5.1 不要使用goto 等级: [必须] 说明:在大型项目中,goto的滥用会导致灾难性后果.因为我们程序中一般不存在从一个函数体内部跳转到另一个函数体内部的场景,所以我们可以将跳转控制在 ...
Windows客户端C/C++编程规范“建议”——函数
1 函数 1.1 代码行数控制在80行及以内等级:[要求] 说明:每个函数的代码行数控制应该控制在80行以内.如果超过这个限制函数内部逻辑一般可以拆分.如果试图超过这个标准,请列出理由.但理由不包含 ...
Windows客户端C/C++编程规范“建议”——变量和常量
8 变量和常量 8.1 尽量不要使用全局变量等级: [要求] 说明:全局变量的滥用和goto的滥用一样,都是一种灾难.它将使得逻辑变得难以调试和控制. 8.2 不涉及外部使用的全局变量需要使用sta ...
Windows客户端C/C++编程规范“建议”——文件
7 文件 7.1 正确使用#include 等级:[推荐] 说明:#include <>和#include ""导致编译器在搜索文件时,搜索的路径顺序不同.所以需要正确 ...
Windows客户端C/C++编程规范“建议”——表达式和运算
4 表达式和运算 4.1 比较操作中将常量设置为左值等级: [推荐] 说明:编写代码时,如果将常量设置为右值.可能因马虎将"=="写成"="导致逻辑错误.这种 ...
Windows客户端C/C++编程规范“建议”——函数调用
3 函数调用 3.1 谨慎使用递归方法等级: [推荐] 说明:递归方式控制不当,可能会导致栈空间不够而崩溃.一般的递归都可以使用循环代替. 3.2 不要使用using namespace 等级: [ ...
Windows客户端C/C++编程规范“建议”——指针
2 指针 2.1 尽量使用智能指针等级: [推荐] 说明:正确使用智能指针可以省去指针管理的工作. 2.2 类成员变量指针释放后一定要置空等级: [必须] 说明:如果类成员变量指针在释放后没有置空 ...

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

前言

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

最新文章

热门文章