软件设计规范.docxVIP

文档 文档 深圳市涪卡科技有眼E司 SHENZHEN DECARD SMARTCARD TECH CO..LTD. 软件设计规范 制定： 审核： 批准： 文件编号 生效日期 版本号 分 发 部 修订履历 序号 版本 修订内容 修订人 修订日期 会签与文件发放： 会签部门 会签人 会签日期 签收部门 签收人 签收日期 深圳市德卡科技有限公司 文件编号 文件版本 A1 生效日期 软件设计规范 发行类别 ■新增 □修订 发行部门 研发中心 TOC \o 1-5 \h \z \o Current Document 第一章、项目模块划分 15 一、 模块划分 15 二、 模块命名 15 \o Current Document 第二章、文件格式 16 \o Current Document 一、 C文件格式说明： 16 \o Current Document 1、 文件创建及修改说明区 16 \o Current Document 2、 头文件引用区 16 \o Current Document 3、 全局变量定义区 17 \o Current Document 4、 驱动函数区 17 \o Current Document 5、 应用函数区 17 \o Current Document 6、 文件结束说明 18 \o Current Document 二、 h文件格式说明 18 \o Current Document 1、 文件创建及修改说明区 18 2、 防重调用定义 18 3、 头文件引用 18 \o Current Document 4、 控制接口定义区 19 \o Current Document 5、 常量定义区 19 \o Current Document 6、 宏调用定义区 19 \o Current Document 7、 类型定义区 19 \o Current Document 8、 外部引用变量区 20 \o Current Document 9、 外部引用函数区 20 \o Current Document 10、 操作流程说明区 20 \o Current Document 11、 文件结束说明 21 深圳市德卡科技有限公司 文件编号 文件版本 A1 生效日期 软件设计规范 发行类别 ■新增 □修订 发行部门 研发中心 第三章、命名规则 21 第三章、命名规则 21 TOC \o 1-5 \h \z \o Current Document 一、 函数命名规则 21 \o Current Document 二、 变量命名规则 22 \o Current Document 三、 宏命名规则 22 \o Current Document 四、 文件命名规则 22 \o Current Document 五、 新定义变量类型命名规则 23 \o Current Document 六、 命名注意事项： 23 \o Current Document 1、 标识符命名基本原则 23 \o Current Document 2、 命名中若使用特殊约定或缩写，则要有注释说明 23 \o Current Document 3、 局部循环变量也必须按照变量命名规则来定义 23 \o Current Document 4、 不要用数字或较奇怪的字符来定义标识符 23 \o Current Document 5、 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 24 \o Current Document 6避免使用以下划线开始和结尾的定义 24 \o Current Document 7、 程序中不要出现仅靠大小写区分的相似的标识符 24 \o Current Document 8、 标识符缩写 24 \o Current Document 9、 函数名应准确描述函数的功能 24 \o Current Document 10、 避免使用无意义或含义不清的动词为函数命名 24 \o Current Document 第四章、代码书写规范 24 一、 基本原则 25 \o Current Document 二、 排版 25 \o Current Document 1、 缩进风格 25 \o Current Document 2、 不要使用【TAB】键 25 \o Current Document 3、 空行 25 \o Current Document 4、 语句长度要小于80个字符 26 \o Current D