软件设计规范
- 格式：doc
- 大小：1.06 MB
- 文档页数：91
软件设计规范
———————————————————————————————— 作者:
———————————————————————————————— 日期：
ﻩ
软件设计规范
制定:
审核:
批准:
文件编号 生效日期 版本号
分
发
部
门
修 订 履 历
序号 版本 修订内容 修订人 修订日期
会签与文件发放:
会签部门 会签人 会签日期 签收部门 签收人 签收日期
深圳市德卡科技有限公司 文件编号
文件版本 A1
生效日期 软件设计规范 发行类别 ■新增 □修订
发行部门 研发中心
目 录
第一章、项目模块划分ﻩ错误!未定义书签。
一、模块划分 .............................................................................................. 错误!未定义书签。
二、模块命名 .............................................................................................. 错误!未定义书签。
第二章、文件格式 ...................................................................................... 错误!未定义书签。
一、ｃ文件格式说明: ................................................................................. 错误!未定义书签。
1、文件创建及修改说明区ﻩ错误!未定义书签。
2、头文件引用区ﻩ错误!未定义书签。
3、全局变量定义区ﻩ错误!未定义书签。
４、驱动函数区ﻩ错误!未定义书签。
５、应用函数区ﻩ错误!未定义书签。
6、文件结束说明ﻩ错误!未定义书签。
二、h文件格式说明ﻩ错误!未定义书签。
1、文件创建及修改说明区 ........................................................................ 错误!未定义书签。
2、防重调用定义 ........................................................................................ 错误!未定义书签。
３、头文件引用20ﻩ
４、控制接口定义区ﻩ错误!未定义书签。
5、常量定义区ﻩ错误!未定义书签。
6、宏调用定义区 ........................................................................................ 错误!未定义书签。
７、类型定义区ﻩ错误!未定义书签。
８、外部引用变量区 .................................................................................. 错误!未定义书签。
9、外部引用函数区 .................................................................................... 错误!未定义书签。
10、操作流程说明区 .................................................................................. 错误!未定义书签。
11、文件结束说明 ...................................................................................... 错误!未定义书签。 深圳市德卡科技有限公司 文件编号
文件版本 A1
生效日期 软件设计规范 发行类别 ■新增 □修订
发行部门 研发中心
第三章、命名规则 ...................................................................................... 错误!未定义书签。
一、函数命名规则 ...................................................................................... 错误!未定义书签。
二、变量命名规则ﻩ错误!未定义书签。
三、宏命名规则ﻩ错误!未定义书签。
四、文件命名规则 ...................................................................................... 错误!未定义书签。
五、新定义变量类型命名规则ﻩ错误!未定义书签。
六、命名注意事项：ﻩ错误!未定义书签。
1、标识符命名基本原则ﻩ错误!未定义书签。
２、命名中若使用特殊约定或缩写,则要有注释说明 ............................. 错误!未定义书签。
3、局部循环变量也必须按照变量命名规则来定义ﻩ错误!未定义书签。
4、不要用数字或较奇怪的字符来定义标识符 ........................................ 错误!未定义书签。
５、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等错误!未定义书签。
６、避免使用以下划线开始和结尾的定义ﻩ错误!未定义书签。
７、程序中不要出现仅靠大小写区分的相似的标识符ﻩ错误!未定义书签。
8、标识符缩写 ............................................................................................ 错误!未定义书签。
９、函数名应准确描述函数的功能ﻩ错误!未定义书签。
10、避免使用无意义或含义不清的动词为函数命名ﻩ错误!未定义书签。
第四章、代码书写规范ﻩ错误!未定义书签。
一、基本原则ﻩ错误!未定义书签。
二、排版ﻩ错误!未定义书签。
1、缩进风格 ................................................................................................ 错误!未定义书签。
2、不要使用【TAB】键ﻩ错误!未定义书签。
3、空行 ........................................................................................................ 错误!未定义书签。
４、语句长度要小于80个字符 ................................................................ 错误!未定义书签。
5、长语句换行ﻩ错误!未定义书签。
6、长表达式换行ﻩ错误!未定义书签。
7、若函数的参数较长，则要进行适当的划分ﻩ错误!未定义书签。 深圳市德卡科技有限公司 文件编号
文件版本 A1
生效日期 软件设计规范 发行类别 ■新增 □修订
发行部门 研发中心
8、一行只写一条语句 ................................................................................ 错误!未定义书签。
9、括号{}ﻩ错误!未定义书签。
1０、语句缩进要求 .................................................................................... 错误!未定义书签。
１1、分界符ﻩ错误!未定义书签。
1２、空格 .................................................................................................... 错误!未定义书签。
三、注释ﻩ错误!未定义书签。
１、注释量 .................................................................................................. 错误!未定义书签。
2、函数头部注释ﻩ错误!未定义书签。
３、代码与注释同时修改 .......................................................................... 错误!未定义书签。
4、注释的内容要清楚、明了，含义准确，防止注释二义性 ................ 错误!未定义书签。
5、避免在注释中使用缩写，特别是非常用缩写 .................................... 错误!未定义书签。
6、注释书写位置ﻩ错误!未定义书签。
７、变量、常量命名不能充分自注释的,必须加以注释 ......................... 错误!未定义书签。
８、数据结构命名不能充分自注释的，必须加以注释 .......................... 错误!未定义书签。
9、全局变量注释 ........................................................................................ 错误!未定义书签。
10、注释要与说描述的内容进行同样的缩排ﻩ错误!未定义书签。
11、将注释与其上面的代码用空行隔开ﻩ错误!未定义书签。
１２、连续case语句处理时,必须编写注释 .......................................... 错误!未定义书签。
13、代码或表达式的中间禁止插入注释 .................................................. 错误!未定义书签。
14、通过正确命名使代码成为自注释的 .................................................. 错误!未定义书签。
１5、在代码的功能、意图层次上进行注释,提供有用、额外的信息 ... 错误!未定义书签。
１６、在程序块的结束行右方加注释标记,以表明某程序块的结束ﻩ错误!未定义书签。
17、注释格式ﻩ错误!未定义书签。
18、采用中文注释ﻩ错误!未定义书签。
1９、使用 #if0和 #endif注释代码块 ...................................................... 错误!未定义书签。
