程序设计写作模板

程序设计(Programming)是指设计、编制、调试程序的方法和过程。程序设计的基本概念有程序、数据、子程序、子例程、协同例程、模块以及顺序性、并发性、并行性、分布性等。程序是程序设计中最为基本的概念，子程序和例程都是为了便于进行程序设计而建立的程序设计基本单位，顺序性、并发性、并行性和分布性反映程序的内在特性。

程序设计是程序编码阶段的第一步。程序设计是对一个系统应用各种技术和原则的过程，这个过程规定了详细的物理实现方法。编码是程序设计的必然结果。

程序设计者的任务是对一个将要“构造”的实体提供一个模型或一种表示方法。

 

供参考的程序设计如下所示。

1.  引言

1.1  目的     

1.2  定义和缩写词

1.3  参考资料

2.  编码风格

2.1  程序编码要采用缩进风格编写

2.2  编写子程序一定要做注释

2.3  相对独立的程序块之间、变量说明之后必须加空行

2.4  较长的语句要分成多行书写

2.5  循环、判断等语句中有较长的表达式或语句，要在低优先级操作符处划分新行，操作符放在新行之首

2.6  若函数或过程中的参数较长，则要进行适当的划分

2.7  一行只写一条语句

2.8  if、for、do、while、switch等语句自占一行,执行语句部分要加括号

2.9  对齐只使用空格键，不使用TAB键

2.10  程序块的分界符应独占一行

3.  注释

3.1  源程序有效注释量必须在20％以上

3.2  说明性文件头部应进行注释

3.3  源文件头部应进行注释

3.4  函数头部应进行注释

3.5  编写代码要边注释

3.6  注释的内容要清楚、明了，含义准确，防止注释二义性

3.7  对数据结构声明

3.8  全局变量要有较详细的注释

3.9  将注释与其上面的代码用空行隔开

3.10 对变量的定义和分支语句必须注释 

4． 标识符命名

4.1  标识符的命名要清晰、明了，有明确含义

4.2  命名中若使用特殊约定或缩写，则要有注释说明

4.3  命名规范必须与所使用的系统风格保持一致

5.  可读性

5.1  注意运算符的优先级

6.  变量、结构

6.1  去掉不必要的公共变量

6.2  仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系

6.3 明确公共变量与操作此公共变量的函数或过程的关系

6.4  当向公共变量传递数据时，防止赋与不合理的值或越界等现象发生

6.5  防止局部变量与公共变量同名  
6.6  严禁使用未经初始化的变量作为右值。
6.7  结构的设计要尽量考虑向前兼容和以后的版本升级
6.8  要注意数据类型的强制转换

6.9  对自定义数据类型进行恰当命名

7.  函数、过程

7.1  对所调用函数的错误返回码要仔细、全面地处理

7.2  明确函数功能

7.3  编写可重入函数时，应注意局部变量的使用

7.4  明确规定对接口函数参数的合法性检查

7.5  避免使用无意义或含义不清的动词为函数命名
7.6  函数的返回值要清楚、明了，让使用者不容易忽视错误情况
7.7  函数本身不递归调用

8． 可测性

8.1  在同一项目组或产品组内，要有一套统一的打印函数

9.  程序效率

9.1  编程时要经常注意代码的效率

9.2  提高代码效率

9.3  循环体内工作量最小化

9.4  尽量减少循环嵌套层次

10.  质量保证

10.1  代码质量保证原则

10.2  只引用属于自己的存贮空间

10.3  过程/函数中分配的内存，在过程/函数退出之前要释放

10.4  防止内存操作越界

10.5  初始化有关变量和运行环境

10.6  不能随意改变与其它模块的接口

10.7  要注意易混淆的操作符

10.8  要注意程序机器码大小

11.  代码编辑、编译、审查

11.1  打开编译器的所有告警开关对程序进行编译

11.2  在产品软件（项目组）中，要统一编译开关选项

11.3  通过代码走读及审查方式对代码进行检查

12.  代码测试、维护

12.1  单元测试要求覆盖语句

12.2  单元测试开始要跟踪每一条语句，并观察数据流及变量的变化

12.3  清理、整理或优化后的代码要经过审查及测试

12.4  代码版本升级要经过严格测试

12.5  使用工具软件对代码版本进行维护

12.6  软件的任何修改都应有详细的文档记录

13.  宏

13.1  用宏定义表达式时，要使用完备的括号

13.2  将宏所定义的多条表达式放在大括号中

13.3  使用宏时，不允许参数发生变化