软件编程规范
软 件 编 程 规 范
拟制: willim
日期: 审核:
日期:
1
2004-05-10 yyyy/mm/dd
软件编程规范
文档历史
日期 2004-5-10 作者 willim 版本号 0.1 备注 初稿
2
软件编程规范
目 录
第零章 前言 ..........................................................................................................................5 第一章 程序的版式 ................................................................................................................6 第二章 注释 ........................................................................................................................ 12 第三章 标识符命名 .............................................................................................................. 16 第四章 可读性 ..................................................................................................................... 20 第五章 变量、结构 .............................................................................................................. 22 第六章 函数、过程 .............................................................................................................. 25 第七章 程序效率 ................................................................................................................. 29 第八章 质量保证 ................................................................................................................. 33
3
软件编程规范
关键词:软件编程规范
摘 要:本规范适用于公司使用C/C++作为开发语言的项目。
缩略语清单:
规则:强制必须遵守的原则。 建议:可以加以考虑的原则。
示例:对此规则或建议从正、反两个方面给出例子。
说明:对本规则、建议的补充说明。?
参考文献:
《Rational Unified Process 2000》 Rational Software Corporation,2000
《移动开发部软件编程规范》 《QQ 组编程精粹培训》
《写代码的十个秘决》
john 腾讯计算机有限公司,2003-2-19
qingming 腾讯计算机有限公司,2003-9-8 sjh
腾讯计算机有限公司,2003-2-19
《零错误代码开发规范》 基础产品部 腾讯计算机有限公司,2003-2-19
《Thinking in C++》 刘宗田 等译,机械工业出版社,2000
4
软件编程规范
第零章 前言
对于软件开发遵循统一的规范,有利于增强代码的可读性,同时防范错误,更好的发挥所使用的语言的优点,提高工作效率。我们在参考已有规范的基础上,制定了本编程规范,用于指导公司的编码活动。
需要注意的是,在本规范中,代码的清晰易懂远比其它方面重要。因为程序的时间、空间效率再高,算法再好,如果可读性差,无法重用、维护和扩展,那么最终是一堆无用的代码,所做的只能是无用功。
要使自己写出的代码做到正确、可靠、简洁、高效(如速度快、内存占用率低等),不是一蹴而就的,这需要不断地总结自己在编写程序中出现的错误,不断地练习才能不断地提高。
“态度决定一切”,写程序时要使自己专注、认真,做到快乐编程。
5