文档介绍：实用标准文案
软件设计规范
制定：
审核：
期
软件设计规范

文件版本 A1
发行类别 ■新增 □修订
发行部门研发中心
第三章、命名规则 23
一、函数命名规则 23
二、变量命名规则 23
三、宏命名规则 24
四、文件命名规则 24
五、新定义变量类型命名规则 25
六、命名注意事项： 25
1、标识符命名基本原则 25
2、命名中若使用特殊约定或缩写，则要有注释说明
3、局部循环变量也必须按照变量命名规则来定义

..................................................25
......................................................25
4、不要用数字或较奇怪的字符来定义标识符 25
5、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 26
6、避免使用以下划线开始和结尾的定义 26
7、程序中不要出现仅靠大小写区分的相似的标识符 26
8、标识符缩写 26
9、函数名应准确描述函数的功能 26
10、避免使用无意义或含义不清的动词为函数命名 26
第四章、代码书写规范 26
一、基本原则 26
二、排版 27
1、缩进风格 27
2、不要使用【 TAB】键 27
3、空行 27
4、语句长度要小于 80 个字符 28
5、长语句换行 28
6、长表达式换行 28
精彩文档
实用标准文案
文件编号
深圳市德卡科技有限公司
生效日期
软件设计规范

文件版本 A1
发行类别 ■新增 □修订
发行部门研发中心
7、若函数的参数较长，则要进行适当的划分 29
8、一行只写一条语句 29
9、括号 {} 29
10、语句缩进要求 30
11、分界符 31
12、空格 32
三、注释 33
1、注释量 33
2、函数头部注释 33
3、代码与注释同时修改 34
4、注释的内容要清楚、明了，含义准确，防止注释二义性 34
5、避免在注释中使用缩写，特别是非常用缩写 34
6、注释书写位置 34
7、变量、常量命名不能充分自注释的，必须加以注释
8、数据结构命名不能充分自注释的，必须加以注释

.............................................34
..................................................35
9、全局变量注释 35
10、注释要与说描述的内容进行同样的缩排 35
11、将注释与其上面的代码用空行隔开 36
12、连续 case 语句处理时，必须编写注释 37
13、代码或表达式的中间禁止插入注释
14、通过正确命名使代码成为自注释的

..........................................................................39
..........................................................................39
15、在代码的功能、意图层次上进行注释，提供有用、额外的信息
16、在程序块的结束行右方加注释标记，以表明某程序块的结束

.....................39
..........................39
17、注释格式 40
18、采用中文注释 40
19、使用 #if0 和 #endif 注释代码块 40
精彩文档
实用标准文案
文件编号
深圳市德卡科技有限公司
生效日期
软件设计规范

文件版本 A1
发行类别 ■新增 □修订
发行部门研发中心
20、注释不能嵌套 41
四、代码可读性 41
1、使用小括号明确表达式的操作顺序 41
2、用有意义的枚举和宏替代数字 41
3、源程序中关系较为紧密的代码应尽可能相邻 42
4、用多行简单语句替代复杂语句