公司编码规范

  • 格式:doc
  • 大小:141.50 KB
  • 文档页数:17

公司编码规范目录第一部分概述 (3)1.1规范制定原则 (3)1.2术语定义 (3)1.2.1Pascal 大小写 (3)1.2.2Camel 大小写 (3)第二部分程序版式 (3)2.1列宽 (3)2.2换行 (3)2.3空行 (3)2.4空格 (4)2.5括号- () (4)2.6花括号- {} (5)2.7注释 (6)2.7.1概述 (6)2.7.2注释的使用 (6)第三部分命名规则 (7)3.1共用部分 (7)3.2C++部分 (8)3.3C#部分 (9)第四部分语句规则 (14)4.1共用部分 (14)4.2C++部分 (14)4.2.1常量 (14)4.2.2if 语句 (14)4.2.2.1布尔变量与零值比较 (14)4.2.2.2整型变量与零值比较 (15)4.2.2.3浮点变量与零值比较 (15)4.2.2.4指针变量与零值比较 (15)4.2.2.5对if语句的补充说明 (15)4.2.3函数 (16)第五部分匈牙利命名法 (16)第一部分概述1.1 规范制定原则1 方便代码的交流和维护。

2 不影响编码的效率,不与大众习惯冲突。

3 使代码更美观、阅读更方便。

4 使代码的逻辑更清晰、更易于理解。

1.2 术语定义1.2.1 Pascal 大小写将标识符的首字母和后面连接的每个单词的首字母都大写。

可以对三字符或更多字符的标识符使用Pascal 大小写。

例如:BackColor1.2.2 Camel 大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写。

例如:backColor第二部分程序版式2.1 列宽代码列宽控制在110字符左右。

2.2 换行当表达式超出或即将超出规定的列宽,遵循以下规则进行换行:1、在逗号后换行。

2、在操作符前换行。

3、规则1优先于规则2。

当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。

2.3 空行空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。

在以下情况下使用两个空行:1、接口和类的定义之间。

2、枚举和类的定义之间。

3、类与类的定义之间。

在以下情况下使用一个空行:1、方法与方法、属性与属性之间。

2、方法中变量声明与语句之间。

3、方法与方法之间。

4、方法中不同的逻辑块之间。

5、方法中的返回语句与其他的语句之间。

6、属性与方法、属性与字段、方法与字段之间。

7、注释与它注释的语句间不空行,但与其他的语句间空一行。

2.4 空格在以下情况中要使用到空格:1、关键字和左括符“(”应该用空格隔开。

如:while ( true )注意在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。

2、多个参数用逗号隔开,每个逗号后都应加一个空格。

3、除了 . 之外,所有的二元操作符都应用空格与它们的操作数隔开。

一元操作符、++及--与操作数间不需要空格。

如A += c + d;A = ( a + b ) / ( c * d );while ( d ++ = s ++ ){n++;}P rintSize(“size is “ + size + “\n”);4、语句中的表达式之间用空格隔开。

如for (expr1; expr2; expr3)2.5 括号- ()1、左括号“(”不要紧靠关键字,中间用一个空格隔开。

2、左括号“(”与方法名之间不要添加任何空格。

3、没有必要的话不要在返回语句中使用()。

如:if ( condition )Array.Remove(1)return 1;2.6 花括号- {}1、左花括号“{”放于关键字或方法名的下一行并与之对齐。

如:if (condition){}public int Add(int x, int y){}2、左花括号“{”要与相应的右花括号“}”对齐。

3、通常情况下左花括号“{”单独成行,不与任何语句并列一行。

4、if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。

如:if (somevalue == 1){somevalue = 2;}5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的 {。

如:while (1){if (valid){} // if validelse{} // not valid} // end forever2.7 注释2.7.1 概述1、修改代码时,总是使代码周围的注释保持最新。

2、在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。

注释样本应该是解释它为什么存在和可以做什么的简短介绍.3、避免在代码行的末尾添加注释;行尾注释使代码更难阅读。

不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。

4、在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。

5、如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。

尽一切可能不注释难以理解的代码,而应该重写它。

尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。

6、在编写注释时使用完整的句子。

注释应该阐明代码,而不应该增加多义性。

7、在编写代码时就注释,因为以后很可能没有时间这样做。

另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。

8、避免多余的或不适当的注释,如幽默的不主要的备注。

9、使用注释来解释代码的意图。

它们不应作为代码的联机翻译。

10、注释代码中不十分明显的任何内容。

11、为了防止问题反复出现,对错误修复和解决方法代码总是使用注释,尤其是在团队环境中。

12、对由循环和逻辑分支组成的代码使用注释。

这些是帮助源代码读者的主要方面。

13、在整个应用程序中,使用具有一致的标点和结构的统一样式来构造注释。

14、用空白将注释同注释分隔符分开。

在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。

15、在所有的代码修改处加上修改标识的注释。

16、为了是层次清晰,在闭合的右花括号后注释该闭合所对应的起点。

2.7.2 注释的使用注释通常用于:(1)版本、版权声明;(2)函数接口说明,要求每个函数开始前必须注释函数功能、输入/输出参数、返回值;(3)重要的代码行或段落提示,特别是逻辑比较复杂或不易理解的算法必须要加上注释。

(4)如果代码本来就是清楚的,则不必加注释。

否则多此一举,令人厌烦。

如: i++; // i 加 1,多余的注释注释例子:第三部分命名规则3.1 共用部分本节论述的共性规则是被大多数程序员采纳的。

1、标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

标识符最好采用英文单词或其组合,便于记忆和阅读。

切忌使用汉语拼音来命名。

程序中的英文单词一般不会太复杂,用词应当准确。

例如不要把CurrentValue写成NowValue。

2、标识符的长度应当符合言简意赅的原则。

例如变量名maxval就比maxValueUntilOverflow好用。

单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。

3、命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。

而Unix 应用程序的标识符通常采用“小写加下划线”的方式,如add_child。

别把这两类风格混在一起用。

4、程序中不要出现仅靠大小写区分的相似的标识符。

例如:int x, X; // 变量x 与 X 容易混淆void foo(int x); // 函数foo 与FOO容易混淆void FOO(float x);5、程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。

6、变量的名字应当使用“名词”或者“形容词+名词”。

例如:float value;float oldValue;float newValue;7、全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。

类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。

例如:DrawBox(); // 全局函数box->Draw(); // 类的成员函数8、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

例如:int minValue;int maxValue;int SetValue(…);int GetValue(…);9、尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。

10、常量全用大写的字母,用下划线分割单词。

例如:const int MAX = 100;const int MAX_LENGTH = 100;3.2 C++部分1、类名、函数名、属性名、方法名、事件名采用Pascal命名法。

例如:class Node; // 类名class LeafNode; // 类名void Draw(void); // 函数名void SetValue(int value); // 函数名2、函数或方法内的变量采用Camel命名法,并采用数据类型作为变量前缀。

例如:BOOL blnFlag;int intDrawMode;3、静态变量加前缀s_(表示static)。

例如:void Init(…){static int s_initValue; // 静态变量…}4、如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。

例如:int g_howManyPeople; // 全局变量int g_howMuchMoney; // 全局变量3.3 C#部分1、命名空间●命名命名空间时的一般性规则是使用公司名称,后跟技术名称和可选的功能与设计,如下所示。

CompanyName.TechnologyName[.Feature][.Design]例如:namespace Sine.Procurement // 采购单管理系统namespace Sine.Procurement.DataRules // 采购单管理系统的业务规则模块●命名空间使用Pascal大小写,用逗号分隔开。

●TechnologyName 指的是该项目的英文缩写,或软件名。

●命名空间和类不能使用同样的名字。

例如,有一个类被命名为Debug后,就不要再使用Debug作为一个名称空间名。

2、类与接口●使用 Pascal 大小写。

●使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML●不要使用类型前缀,如在类名称上对类使用 C 前缀。

例如,使用类名称FileStream,而不是CFileStream。

●不要使用下划线字符 (_)。

●接口以字母 I 开始的类名称。