编
号:MPDKZY022007
计算机源代码编写规范
发布时间:20070628编制:
修改号:0发放号:实施时间:20070628批准:
计算机源代码编写规范
目录计算机源代码编写规范11目的12编写对象23规范内容23.1注释规则23.2命名规则23.3源代码规则33.4用户界面规范43.5合理性原则43.6不同语言的具体规定。4
1目的
在软件开发过程中,编程的工作量是相当大的,同一项目参与编程的人可能有各自编程的经验和习惯,不同风格的程序代码使维护工作变得复杂和困难。为了提高代码的可读性、系统的稳定性及降低维护和升级的成本,特编写本规范以统一各开发人员的编程工作。
f2编写对象
本规定适用于所有软件的源程序编写。客户有特殊要求时,则遵循客户提出的要求。对于移植性开发或低版本的升级开发,则按照前一版本的格式要求。
3规范内容
3.1注释规则1一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。2说明性文件(如头文件h文件、文件、i
cdef文件、编译说明文件cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。3源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的功能、主要函数及其功能、修改日志等r