软件源代码编写规范


1.目的
良好的编程风格是提高程序可靠性非常重要的手段，也是大型项目多人合作开发的技术基础。本规范的目的在于通过规范定义来避免不好的编程风格，增强程序的易读性，便于自己和其它程序员理解。
2.适用范围
本规定适用于所有软件的源程序编写。客户有特殊要求时，则遵循客户提出的要求。
3.规范内容
基本要求
3.1.1.程序结构要求
1）程序结构清晰，简单易懂，单个函数的程序代码行数建议不超过100行，函数功能尽量单一。
2）目标明确，代码简洁清晰，单行代码最大字符数建议不超过120个。
3）避免随意定义全局变量，尽量使用局部变量。
3.1.2.可读性要求
1）在保证代码可读性的前提下提高代码执行效率，对执行效率要求比较高的关键代码可以除外。
2）保持注释与代码完全一致，当代码更改后及时更新相应的注释。
3）每个源程序文件，都有文件头说明，说明内容见“源代码文件的注释”。
4）每个函数，都有函数头说明，说明内容见“函数或过程的注释”。
5）函数中尽量减少输出参数的使用。
6）主要变量（结构、联合、类或对象）定义或引用时，添加注释，反映其含义。
7）处理过程的每个主要阶段、典型算法前都应有相应的简单说明性注释。
8）利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，不建议使用空格。
9）循环、分支层次尽量不要超过五层。建议多层循环在每层循环结束语句后注释说明退出的相应层次。
10）注释的位置可以在相应代码的上一行或同一行。
11）一目了然的语句不加注释。
12）常量定义（DEFINE）有相应说明。
3.1.3.结构化要求
1）不建议使用GOTO语句。
2）用 IF 语句来强调只执行两组语句中的一组。不建议使用 ELSE GOTO 和 ELSE RETURN。
3）html单行文本框代码怎么写避免从循环引出多个出口。
4）避免不必要的分支。
3.1.4.正确性与容错性要求
1）除特殊使用情况，所有变量在定义时建议进行初始化。
2）对所有的用户输入，建议在函数或程序开始前进行合法性检查。
3）在修改错误前首先考虑是否对其它代码的影响，避免因此产生新的错误。
4）使用规范的容错语句，提供完善的异常处理措施，如文件能否逻辑锁定、打印机是否联机等,对于明确的错误,要有明确的容错代码提示用户。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。