软件设计规范.doc

软件设计规范制定:审核:批准:文件编号生效日期版本号分发部门修订履历序号版本修订内容修订人修订日期会签与文件发放:会签部门会签人会签日期签收部门签收人签收日期深圳市德卡科技有限公司文件编号文件版本A1生效日期软件设计规范发行类别■新增□修订发行部门研发中心深圳市德卡科技有限公司文件编号文件版本A1生效日期软件设计规范发行类别■新增□修订发行部门研发中心目录第一章、项目模块划分 15一、模块划分 15二、模块命名 15第二章、文件格式 15一、c文件格式说明: 161、文件创建及修改说明区 162、头文件引用区 163、全局变量定义区 164、驱动函数区 165、应用函数区 176、文件结束说明 17二、h文件格式说明 171、文件创建及修改说明区 172、防重调用定义 183、头文件引用 184、控制接口定义区 185、常量定义区 196、宏调用定义区 197、类型定义区 198、外部引用变量区 199、外部引用函数区 2010、操作流程说明区 2011、文件结束说明 20深圳市德卡科技有限公司文件编号文件版本A1生效日期软件设计规范发行类别■新增□修订发行部门研发中心第三章、命名规则 21一、函数命名规则 21二、变量命名规则 21三、宏命名规则 22四、文件命名规则 22五、新定义变量类型命名规则 22六、命名注意事项: 221、标识符命名基本原则 232、命名中若使用特殊约定或缩写,则要有注释说明 233、局部循环变量也必须按照变量命名规则来定义 234、不要用数字或较奇怪的字符来定义标识符 235、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 236、避免使用以下划线开始和结尾的定义 237、程序中不要出现仅靠大小写区分的相似的标识符 238、标识符缩写 249、函数名应准确描述函数的功能 2410、避免使用无意义或含义不清的动词为函数命名 24第四章、代码书写规范 24一、基本原则 24二、排版 241、缩进风格 242、不要使用【TAB】键 243、空行 244、语句长度要小于80个字符 255、长语句换行 256、长表达式换行 267、若函数的参数较长,则要进行适当的划分 26深圳市德卡科技有限公司文件编号文件版本A1生效日期软件设计规范发行类别■新增□修订发行部门研发中心8、一行只写一条语句 269、括号{} 2710、语句缩进要求 2711、分界符 2812、空格 29三、注释 301、注释量 302、函数头部注释 303、代码与注释同时修改 314、注释的内容要清楚、明了,含义准确,防止注释二义性 315、避免在注释中使用缩写,特别是非常用缩写 316、注释书写位置 317、变量、常量命名不能充分自注释的,必须加以注释 328、数据结构命名不能充分自注释的,必须加以注释 329、全局变量注释 3210、注释要与说描述的内容进行同样的缩排 3211、将注释与其上面的代码用空行隔开 3312、连续case语句处理时,必须编写注释 3413、代码或表达式的中间禁止插入注释 3614、通过正确命名使代码成为自注释的 3615、在代码的功能、意图层次上进行注释,提供有用、额外的信息 3616、在程序块的结束行右方加注释标记,以表明某程序块的结束 3617、注释格式 3718、采用中文注释 3719、使用#if0和#endif注释代码块 3720、注释不能嵌套 37四、代码可读性 37深圳市德卡科技有限公司文件编号文件版本A1生效日期软件设计规范发行类别■新增□修订发行部门研发中心1、使用小括号明确表达式的操作顺序 372、用有意义的枚举和宏替代数字 383、源程序中关系较为紧密的代码应尽可能相邻 394、用多行简单语句替代复杂语句 39五、变量,结构 401、公共变量 、去掉没必要的公共变量 、仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系 、明确公共变量与操作此公共变量的函数或过程的关系 、要谨慎向公共变量传递数据 、防止局部变量与公共变量同名。 、公共变量仅由模块或函数创建和修改,其余模块和函数只能访问 402、局部变量 、严禁使用未经初始化的变量作为右值 、不使用与硬件或软件环境关系密切的变量 、变量声明时,同一类型,不同意义的多个变量,要分行,便于区分 、对只设置一次的变量,宜使用“const”限定词进行声明 、避免在函数中使用static局部变量 413、数组 、数组大小及初始值要明确定义 、数组、结构和联合的初始化列表应显式描述 414、结构、联合 、结构的功能要单一,是针对一种事务的抽象 、不要设计面面俱到、非常灵活的数据结构