软件系统开发规范_第1页
软件系统开发规范_第2页
软件系统开发规范_第3页
软件系统开发规范_第4页
软件系统开发规范_第5页
已阅读5页，还剩1页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

软件系统开发规范篇一：系统开发部编程规范C#书写规范 目 录 1 目的 ? 2 范围 ? 3 注释规范 概述 ? 自建代码文件注释? 模块（类）注释 ? 类属性注释 ? 方法注释 ?代码间注释 ? 4 命名总体规则 5 命名规范 变量（Variable）命名 ? 常量命名? 类（Class）命名 ? 接口（Interface）命名? 方法（Method）命名 ? 名称空间(Namespace）命名 ? 6 编码规则 错误检查规则 ? 大括号规则 ? 缩进规则 ?小括号规则 ? If else 规则? 比较规则 ? Case 规则 ?对齐规则 ?单语句规则 ? 单一功能规则? 简单功能规则? 明确条件规则? 选用 FALSE 规则 ? 独立赋值规则? 定义常量规则? 模块化规则? 交流规则? 7 编程准则 变量使用 ?数据库操作 ? 对象使用 ?模块设计原则 ? 结构化要求 ? 函数返回值原则 ? 8 代码包规范代码包的版本号 ? 9 代码的控制 代码库/目录的建立 ? 代码归档 ? 10 输入控制校验规则 登陆控制 ? 数据录入控制 ? 11数据库命名和使用规范 附件 1：数据类型缩写表 附件 2：服务器控件名缩写表 附件 3：代码生成器生成代码格式 1 目的 一. 为了统一公司软件开发设计过程的编程规范。 二. 使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义。 三. 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 四. 编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET 平台的软件开发工作。 2 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 3 注释规范 概述 注释要求写清楚作者，时间，功能描述，参数描述，返回数据。 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。 每行注释的最大长度为 100 个字符。 将注释与注释分隔符用一个空格分开。 不允许给注释加外框。 编码的同时书写注释。 重要变量必须有注释。 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。 如: int m_intLevel,m_intCount; /注释 string m_strSql; /注释 典型算法必须有注释。 在循环和逻辑分支地方的上行必须就近书写注释。 程序段或语句的注释在程序段或语句的上一行 在代码交付之前，必须删掉临时的或无关的注释。 为便于阅读代码，每行代码的长度应少于 100 个字符。 自建代码文件注释 对
人人文库> 全部分类> 办公材料 > 思想汇报

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论