美邦.软件开发规范.doc

美邦.软件开发规范 概述 1 1) 排版 2 2) 注释 2 3）命名技巧 4 3.1过程 4 3.2变量 4 3.3常量 6 3.4接口（Interface）命名规范 6 3.5其它 6 3.6 类型前缀 7 3.7控件类型命名前缀 7 4) 编程约束 9 5) 用户界面 14 5.1概述 14 5.2总体规范 14 5.3 人机交互窗口设计规范 14 5.3.1易用性原则 14 5.3.2安全性原则 15 5.2.3合理性原则 15 5.3.4美观与协调性原则 17 6) 总则 17 概述 编码标准应该始终贯穿代码生产的各个阶段，开发者应该严格遵守，以利于标准的执行。由开发团队完成的源代码应该表现出一致协调的风格。 在软件开发过程中，编程的工作量是相当大的，同一项目参与编程的人可能有各自编程的经验和习惯，不同风格的程序代码带来了维护工作量的增加，因此为了提高代码的可读性、系统的稳定性及维护和升级的成本，程序的代码必须严格遵循统一的编程规范。 总则： 应有良好的、尽可能一致的编程风格 编码应该是严谨的、可读性强、目标明确及直观的。 每一位开发人员或者外包工作人员必须严格执行下述标准： 1) 排版 编写程序时要采用缩进风格，缩进的空格数为4个。 相对独立的程序块之间，变量说明之后必须加空行。 较长的语句要分成多行书写，要在操作符处划分新行，操作符放在新行行首，划分出的新行要进行适当的缩进，增强可读性。 除了特殊的IF语句外，多个短语句不能写在一行中，每行写一句。 如果函数或过程的参数较长，要进行适当的划分。 循环、判断等语句中如果有较长的表达式或语句，要进行适当的划分。 只使用空格键，不要使用TAB键。 函数或过程的开始、循环或判断等语句中的代码都要采用缩进风格，case语句下的分支语句也要采用缩进。 为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏 当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 每一行上放置的语句避免超过一条。 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。 例：int j = i + k; 而不应写为 int j=i+k; 将大的复杂代码节分为较小的、易于理解的模块。 编写 SQL 语句时，对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例如： SELECT FirstName, LastName FROM Customers WHERE State = WA 2) 注释 软件文档可以分为两种形式，外部文档和内部文档。外部文档是与源代码分开的，比如说明书、帮助文档和设计文档。内部文档主要包括开发人员开发时写在源代码里的注释。外部文档应该包括使用说明、设计报告、变换需求、bug修复历程，以及所使用的编码标准。即使有了外部文档，源代码清单也应该独立，因为这些外部文档可能会丢失。 不要给注释添上一个花哨的外框，这看起来很吸引人，但不容易维护。代码交付使用之前，删掉临时的或无关的注释，避免在将来维护工作中引起混淆。如果你需要给一段复杂代码注释，最好重新审视你的代码，然后决定要不要重写。有可能的话，与其给不好的代码注释，不如重新编写。尽管不要为了让别人使用方便而牺牲性能，但是在性能和可维护性之间必须找到一个平衡点。注释时尽可能使用完整的句子，注释应该让代码变得清晰，而不是变得更加含糊。编码的同时就应该写注释，因为大多数情形下，以后就没时间做这个工作。而且，即使你有机会重新阅读你的代码，然而今天看起来很显然的东西，六个星期以后就不再那么清楚明白了。 避免使用多余的或不相称的注释，比如幽默的评论。 使用注释说明代码的意图，而不是简单地翻译代码。 对代码中任何不是很显然的内容进行注释。 为了防止再出问题，通常在bug修复的地方写上注释，这对于团队开发尤为重要。 在循环和逻辑分支的地方写上注释，因为这些地方对于阅读源代码的人来说是关键的区域。 将注释与注释分隔符用空白分开，这样有利于让注释显得突出，特别是在没有颜色提示下更容易找到。 在整个应用程序中，采用统一风格的注释，包括一致的标点符号和结构。 ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ///