《华为编程规范》

全局变量要有较详细的注释,包括对基功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

示例:

1  /* The ErrorCode when SCCP translate.Global Title failure,as follows*/    变量作用
2
3   /*0 - SUCCESS    1 - GT Table error   2 - GT error others - no use*/        变量取值范围
4
5  /*only function SCCPTranslate()in this modual can modify it,and other*/     使用方法
6
7 /*modual can visit it through call the function GetGTTransErrorCode()*/
8
9 Byte g_GTTranErrorCode;

在程序块的结束行加注释标记,以表明程序块的结束。

例:

1   //end of for()
2
3     //end of if(flg)
4
5     //end of while(MAX_MIN)

标识符缩写

较短的单词可通过去掉“元音”形成缩写,较长的单词取单词的头几个字母形成缩写,一些单词有公认的缩写:

temp -> tmp           flag->flg

statistic -> stat         increment -> inc

message -> msg

不要设计面面俱到,非常灵活的数据结构。容易引起误解和操作困难。

尽量用乘法或其它方法代替除法,特别是浮点运算中的除法。

说明:浮点运算除法要占用较多的CPU资源。

示例:

1 #define PAI 3.1416
2 radius = circle_length/(2*PAI);

可以改写成:

1 #define PAI_RECIPROCAL (1/3.1416)
2 radius = circle_length*PAI_RECIPROCAL/2;

过程/函数中申请的(为打开文件而使用的)文件句柄,在过程/函数退出之前要关闭。

说明:分配内存不释放以及文件句柄不关闭是较常见的错误。往往引起严重的后果。

使用宏时,不允许参数发生变化

例:

1 #define SQUARE(a) ((a)*(a))
2 int a = 5;
3 int b;
4 b = SQUARE (a++);// a = 7 ,执行两次自增

正确的用法是:

1 #define SQUARE(a) ((a)*(a))
2 int a = 5;
3 int b;
4 b = SQUARE (a);
5 a++;//a=6

不可将布尔变量直接与TRUE,FALSE或者1,0进制比较。

TRUE的值究竟是什么值并没有统一的标准。例如,visual c++将TRUE定义为1,而visual basic则将TRUE定义为-1.

正确使用:

if(flg)

if(!flg)

类中的常量定义

例:

1 class A
2 {
3     ...
4     const int SIZE = 100;//error
5     int array[SIZE];//error
6 };
类中的常量用类中的枚举常量来实现。
1 class A
2 {
3      ...
4     enum{SIZE1 = 100, SIZE2 = 200};
5     int array1[SIZE1];//OK
6     int array2[SIZE2];//OK
7 };

来自为知笔记(Wiz)

时间: 2024-11-10 11:12:15

《华为编程规范》的相关文章

CI框架源码阅读笔记3 全局函数Common.php

从本篇开始,将深入CI框架的内部,一步步去探索这个框架的实现.结构和设计. Common.php文件定义了一系列的全局函数(一般来说,全局函数具有最高的加载优先权,因此大多数的框架中BootStrap引导文件都会最先引入全局函数,以便于之后的处理工作). 打开Common.php中,第一行代码就非常诡异: if ( ! defined('BASEPATH')) exit('No direct script access allowed'); 上一篇(CI框架源码阅读笔记2 一切的入口 index

IOS测试框架之:athrun的InstrumentDriver源码阅读笔记

athrun的InstrumentDriver源码阅读笔记 作者:唯一 athrun是淘宝的开源测试项目,InstrumentDriver是ios端的实现,之前在公司项目中用过这个框架,没有深入了解,现在回来记录下. 官方介绍:http://code.taobao.org/p/athrun/wiki/instrumentDriver/ 优点:这个框架是对UIAutomation的java实现,在代码提示.用例维护方面比UIAutomation强多了,借junit4的光,我们可以通过junit4的

Yii源码阅读笔记 - 日志组件

?使用 Yii框架为开发者提供两个静态方法进行日志记录: Yii::log($message, $level, $category);Yii::trace($message, $category); 两者的区别在于后者依赖于应用开启调试模式,即定义常量YII_DEBUG: defined('YII_DEBUG') or define('YII_DEBUG', true); Yii::log方法的调用需要指定message的level和category.category是格式为“xxx.yyy.z

源码阅读笔记 - 1 MSVC2015中的std::sort

大约寒假开始的时候我就已经把std::sort的源码阅读完毕并理解其中的做法了,到了寒假结尾,姑且把它写出来 这是我的第一篇源码阅读笔记,以后会发更多的,包括算法和库实现,源码会按照我自己的代码风格格式化,去掉或者展开用于条件编译或者debug检查的宏,依重要程度重新排序函数,但是不会改变命名方式(虽然MSVC的STL命名实在是我不能接受的那种),对于代码块的解释会在代码块前(上面)用注释标明. template<class _RanIt, class _Diff, class _Pr> in

CI框架源码阅读笔记5 基准测试 BenchMark.php

上一篇博客(CI框架源码阅读笔记4 引导文件CodeIgniter.php)中,我们已经看到:CI中核心流程的核心功能都是由不同的组件来完成的.这些组件类似于一个一个单独的模块,不同的模块完成不同的功能,各模块之间可以相互调用,共同构成了CI的核心骨架. 从本篇开始,将进一步去分析各组件的实现细节,深入CI核心的黑盒内部(研究之后,其实就应该是白盒了,仅仅对于应用来说,它应该算是黑盒),从而更好的去认识.把握这个框架. 按照惯例,在开始之前,我们贴上CI中不完全的核心组件图: 由于BenchMa

CI框架源码阅读笔记2 一切的入口 index.php

上一节(CI框架源码阅读笔记1 - 环境准备.基本术语和框架流程)中,我们提到了CI框架的基本流程,这里这次贴出流程图,以备参考: 作为CI框架的入口文件,源码阅读,自然由此开始.在源码阅读的过程中,我们并不会逐行进行解释,而只解释核心的功能和实现. 1.       设置应用程序环境 define('ENVIRONMENT', 'development'); 这里的development可以是任何你喜欢的环境名称(比如dev,再如test),相对应的,你要在下面的switch case代码块中

Apache Storm源码阅读笔记

欢迎转载,转载请注明出处. 楔子 自从建了Spark交流的QQ群之后,热情加入的同学不少,大家不仅对Spark很热衷对于Storm也是充满好奇.大家都提到一个问题就是有关storm内部实现机理的资料比较少,理解起来非常费劲. 尽管自己也陆续对storm的源码走读发表了一些博文,当时写的时候比较匆忙,有时候衔接的不是太好,此番做了一些整理,主要是针对TridentTopology部分,修改过的内容采用pdf格式发布,方便打印. 文章中有些内容的理解得益于徐明明和fxjwind两位的指点,非常感谢.

CI框架源码阅读笔记4 引导文件CodeIgniter.php

到了这里,终于进入CI框架的核心了.既然是"引导"文件,那么就是对用户的请求.参数等做相应的导向,让用户请求和数据流按照正确的线路各就各位.例如,用户的请求url: http://you.host.com/usr/reg 经过引导文件,实际上会交给Application中的UsrController控制器的reg方法去处理. 这之中,CodeIgniter.php做了哪些工作?我们一步步来看. 1.    导入预定义常量.框架环境初始化 之前的一篇博客(CI框架源码阅读笔记2 一切的入

jdk源码阅读笔记之java集合框架(二)(ArrayList)

关于ArrayList的分析,会从且仅从其添加(add)与删除(remove)方法入手. ArrayList类定义: p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Monaco } span.s1 { color: #931a68 } public class ArrayList<E> extends AbstractList<E> implements List<E> ArrayList基本属性: /** *

dubbo源码阅读笔记--服务调用时序

上接dubbo源码阅读笔记--暴露服务时序,继续梳理服务调用时序,下图右面红线流程. 整理了调用时序图 分为3步,connect,decode,invoke. 连接 AllChannelHandler.connected(Channel) line: 38 HeartbeatHandler.connected(Channel) line: 47 MultiMessageHandler(AbstractChannelHandlerDelegate).connected(Channel) line: