【ACCESS精品源码栏目提醒】:网学会员,鉴于大家对ACCESS精品源码十分关注,论文会员在此为大家搜集整理了“【精品】开发标准规范V1 - 其它资料”一文,供大家参考学习!
眉山启明星铝业信息化管理系统ERP 开发标准规范文件状态: 文件标识: 眉山启名星铝业开发标准规范 草稿 当前版本: V1.0 正式发布 编 写: 徐秀青 正在修改 审 核: 签 发: 版 本 历 史 版本/状态 作者 参与者 起止日期 备注草稿 徐秀青 裴常喻 石利 2007.9.10-1 目的 为了保证企业编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。
2 范围 适用于企业所有基于.NET 平台的软件开发工作。
3 规范内容3.1 代码格式 所有的缩进为 4 个空格,使用 VS.NET 的默认设置。
在代码中垂直对齐左括号和右括号。
ifx0 Response.Write用户编号必须输入! 不允许以下情况: ifx0 Response.Write用户编号必须输入! 或者: ifx0 Response.Write用户编号必须输入! 为了防止在阅读代码时不得不滚动源代码编辑器,每行代码或注释在 1024800 的显示 频率下不得超过一显示屏当一行被分为几行时,通过将串联运算符放在每一行的末尾 而不是开头,清楚地表示没有后面的行是不完整的 每一行上放置的语句避免超过一 条。
在大多数运算符之前和之后使用空格,这样做时不会改变代码的 意图却可以使代码容易阅读。
例: int j i k 而不应写为 int jik 将大的复杂代码节分为较小的、易于理解的模块。
编写 SQL 语句时,对于关键字 使用全部大写,对于数据库元素(如表、列和视图)使用大小写混合。
将每个主要的 SQL 子句放在不同的行上,这样更容易阅读和编辑语句, 例如: SELECT FirstName LastName FROM Customers WHERE State WA3.2 注释(Comment)规范 注释规范包括:模块(类)注释规范、类的属性、方法注释规范、代码间注释3.2.1 模块(类)注释规范 模块开始必须以以下形式书写模块注释: /// ///模块编号: ///作用: ///作者:作者中文名 ///编写日期: /// 如果模块有修改,则每次修改必须添加以下注释: /// ///Log 编号: ///修改描述: ///作者:修改者中文名 ///修改日期: ///3.2.2 类属性注释规范 在类的属性必须以以下格式编写属性注释: /// ///属性说明 ///3.2.3 方法注释规范 在类的方法声明前必须以以下格式编写注释 /// /// 说明: /// /// /// /// ///3.2.4 代码间注释规范 代码间注释分为单行注释和多行注释: 单行注释: // 多行注释: /多行注释 1 多行注释 2 多行注释 3/ 代码中遇到语句块时必须添加注释(ifforforeach……)添加的注释必须能够说 明此语句块的作用和实现手段(所用算法等等) 。
3.3 变量(Variable)命名规范3.3.1 程序文件.cs中的变量命名规则 程序中变量名称 变量的前缀 代表变量含意的英文单词或单词缩写。
类模块级的变量请用“m_”作前缀 public class hello private string m_Name private DateTime m_Date 类的属性所对应的变量,采用属性名前加“m_”前缀的形式 public class hello private string m_Name public string Name get return m_Name 过程级的变量不使用前缀 public class hello void say string SayWord 过程的参数使用“p_”作为参数 public class hello void saystring p_SayWord 补充说明: 针对异常捕获过程中的 Exception 变量命名,在没有冲突的情况下,统一命名为 e;如果有冲突的情况下,可以重复 e,比如:ee。
Try //your code try //code catchException ee //your code catchException e //your code 补充:如果捕获异常不需要作任何处理,则不需要定义 Exception 实例 例: try //your code catch Exception 鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简 化它们的阅读。
每个单词的第一个字母都是大写. 即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的 名称。
仅对于短循环索引使用单字母变量名,如 i 或 j。
在变量名中使用互补对,如 min/max、begin/end 和 open/close。
不要使用原义