成都xx信息技术有限公司编码标准规范.doc

成都晓夜信息技术有限公司
文档编号
产品版本
密级
XY-HL-2004-07
技术B级
草案
共 30 页
成都晓夜信息技术有限公司
编码标准规范
(仅供内部使用)
文档作者: 周开庆日期: 07/17/2004
成都晓夜信息技术有限公司
版权所有不得复制
目录
一、开发环境 1
二、软件编码设计标准规范 1
1 编写目的: 1
一:对象命名约定 3
二:常量和变量命名约定 5
注释 9
格式 15
文档修改记录 20
一、开发环境
Microsoft Windows 2000,2003 Server/XP 为运行平台。
前台采用Microsoft Visual Studio .NET中文版中的Visual C#.NET作开发工具, Web应用程序及Web 服务,后台以Microsoft SQL Server 2000中文版作数据库来管理数据存储。
屏幕分辨率:800×600 ,界面字体为宋体,字号为9Twip,大字体,可在程序启动后自动设定。
二、软件编码设计标准规范
1 编写目的:
使用统一编码约定集的主要原因,是使应用程序的结构和编码风格标准化,以便于阅读和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观。
一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。编码约定的目的是使程序易于阅读和理解,而不是用过份的约束和绝对的限制来束缚程序员本身的创造性。
:
全面的编码标准包含代码结构的所有方面。虽然开发人员在实现标准时应慎重,但只要应用了就应该坚持。完成的源代码应该反映出一致的样式,就像一个开发人员在一个会话中编写代码一样。在开始软件项目时,建立编码标准以确保项目的所有开发人员协同工作。当软件项目并入现有的源代码时,或者在现有软件系统上执行维护时,编码标准应说明如何处理现有的基本代码。
源代码的可读性对于开发人员对软件系统的理解程度有直接影响。代码的可维护性是指为了添加新功能、修改现有功能、修复错误或提高性能,可以对软件系统进行更改的难易程度。尽管可读性和可维护性是许多因素的结果,但是软件开发中有一个特定的方面受所有开发人员的影响,那就是编码方法。确保开发小组生产出高质量代码的最容易方法是建立编码标准,然后在例行代码检查中将执行此标准。出色的编码方法和编程做法是专业程序员的标志。大多数编程包括进行许多小的选择,而这些小的选择共同尝试解决一大批问题。程序员的技巧和专业知识在很大程度上决定了那些选择是否明智。
:
软件编码要遵循以下原则:
(1).遵循开发流程,在设计的指导下进行代码编写。
(2).代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。
(3).程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。
(4).程序可读性强,易于理解;方便调试和测试,可测试性好。
(5).易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。
(6).占用资源少,以低代价完成任务。
(7).在不降低程序的可读性的情况下,尽量提高代码的执行效率。
编码的方法:
编码方法合并了软件开发的许多方面。尽管它们通常对应用程序的功能没有影响,但它们对于改善对源代码的理解是有帮助的。这里考虑了所有形式的源代码,包括编程、脚本撰写、标记和查询语言。不建议将这里定义的编码方法形成一套固定的编码标准。相反,它们旨在作为开发特定软件项目的编码标准的指南。
编码方法分为三部分: 命名、注释、格式
命名
:
对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。
例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
符号命名规则: 选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准符号名包括模块名、常量名、标号名、子程序名等。这些名字应该能反映它所代表的实际东西,具有一定的意义,使其能够见名知义,有助于对程序功能的理解。
:
命名采用匈牙利命名法。规则如下:
(1)所有宏定义、枚举常数和const变量,用大写字母命名。在复合词里用下划线隔开每个词。
(2)复合词