《软件编码风格规范》.doc

《《软件编码风格规范》.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、计算机源代码编写规范GEO-QT-00-733修改章节修改内容版本号编写/修改审阅批准所有新发布B0王琳王密朱欣焰B0版审批记录：目录1.目的12.适用范围13.读者对象14.基本编码风格指导14.1.标识符命名及书写14.1.1.标识符的命名14.1.2.源代码文件标识符命名24.2.注释及格式要求24.2.1.源代码文件的注释24.2.2.函数或过程的注释24.2.3.语句的注释34.2.4.常量和变量的注释34.2.5.控制结构的缩进34.2.6.缩进的限制34.3.数据说明44.4.语句结构44.5.代码编写要求44.5.1.基本要求44.5.2.可读性要求54.5.3.

2、结构化要求54.5.4.正确性与容错性要求54.5.5.可重用性要求65.VC编码规范65.1.命名65.1.1.变量名、宏65.1.2.局部变量（或自动变量）65.1.3.全局变量65.1.4.类成员变量（或类数据成员）65.1.5.函数变量65.1.6.宏65.2.枚举定义风格75.3.输出动态库约定75.4.常用数据类型约定符75.4.1.字符、字符串75.4.2.整型85.4.3.浮点数85.4.4.不定类型指针85.4.5.布尔型、字节型95.4.6.句柄（32bits）95.4.7.Windows结构变量95.4.8.WindowsMFC库中定义的独立对象结构和集合类

3、105.5.GeoStar类实例变量（对象）定义115.6.6.6.函数名115.6.1.全局函数名115.6.2.一般函数115.7.类定义风格125.8.接口定义风格125.9.Windows中几个常用宏125.10.IDL参数的定义126.Dephi编码规范126.1.源程序书写规范126.1.1.通用源代码格式规则126.1.1.1.缩进126.1.1.2.边距136.1.1.3.begin...end语句136.1.1.4.注释136.1.2.ObjectPascal语句格式语句书写规范与用法136.1.2.1.括号136.1.2.2.保留字和关键字136.1.2.3.

4、过程和函数146.1.2.4.变量156.1.2.5.类型156.1.2.6.语句166.1.2.7.结构化异常处理176.2.命名规范186.2.1.过程(Procedure)与函数(Function)186.2.1.1.命名186.2.1.2.形参186.2.1.3.命名冲突186.2.2.常量（Constants）和变量(Variable)186.2.2.1.常量186.2.2.2.变量186.2.3.类型(Type)196.2.3.1.一般类型196.2.3.2.类型(Class)196.2.3.3.元件类型216.2.3.4.窗体与对话框类型236.2.3.5.数据模块

5、类型256.2.4.文件256.2.4.1.窗体文件256.2.4.2.数据模块文件256.2.4.3.远程数据模块文件256.2.4.4.单元文件256.3.源程序文档注释规范276.3.1.注释文档的一般规范286.3.1.1.注释位置286.3.1.2.注释块286.3.1.3.忽略文档注释286.3.2.单元文件注释文档格式296.3.3.函数（属性）的注释文档格式296.4.Delphi代码自动格式化工具307.Java编码规范307.1.编码规范307.1.1.格式307.1.1.1.缩进307.1.1.2.间隔317.1.1.3.空行327.1.1.4.类成员的摆放

6、顺序327.1.1.5.文件格式327.1.1.6.行最大长度337.1.1.7.括号337.1.1.8.标识符337.1.1.9.类和接口337.1.1.10.包337.1.1.11.其它标识符337.1.1.12.get和set方法337.1.1.13.注释337.1.1.14.JavaDoc347.1.1.15.代码的自我说明367.1.2.编码377.1.2.1.决不要使用的结构377.1.2.2.初始化387.1.2.3.作用域（scope）387.2.编码规则387.2.1.类型与变量命名规则387.2.2.创建类的规则397.2.3.单元测试397.2.4.类方法设

7、计397.2.5.类设计397.2.6.尽量私有化397.2.7.使用内部类407.2.8.文档注释407.2.9.使用常数定义407.2.10.类创建处理407.2.11.类清除处理407.2.12.使用数组传参417.2.13.抽象类与接口的选择417.2.14.源文件保存41计算机源代码编写规范GEO-QT-00-733B0版1.目的良好的编程风格是提高程序可靠性非常重要的手段，也是大型项目多人合作开发的技术基础。编程风格统一与否直接影响着软件的可维护性、可读性的好坏，以及