中农大网络程序员规范(拟).docVIP

中农大网络程序员规范(拟) 文档规范 修改文档规范 单号： 程序员： 日期： 项目名称： 模块名称： 任务描述一 数据库 库名： 增加： Sql语句 原因 修改： Sql语句 原因： 删除： Sql语句 原因： 文件 增加： 文件列表 原因 修改： 文件列表 原因 删除： 文件列表 原因 任务描述二 数据库 库名： 增加： Sql语句 原因 修改： Sql语句 原因： 删除： Sql语句 原因： 文件 增加： 文件列表 原因 修改： 文件列表 原因 删除： 文件列表 原因 任务描述N。。。。。 数据库 库名： 增加： Sql语句 原因 修改： Sql语句 原因： 删除： Sql语句 原因： 文件 增加： 文件列表 原因 修改： 文件列表 原因 删除： 文件列表 原因 B、新开发文档 程序员： 日期： 项目名称： 模块名称： 模块描述： 涉及库表 (所有者.库名.表名 格式) 涉及文件 处理流程图 程序结构图 注释 必须完善下面注释，注释语句简明扼要，清晰，一般占程序的20%。 1、一般性原则： // 或者 /// 后空一格 2、特定性原则 文件 在Cs的开头，必须写名该文件的作用，关联部分，说明等注释。 格式如： /* // 说明： // 作者： // 时间： */ 类 在定义类的上方，简要说明类的作用，作者。 格式如： /// summary /// 说明：类的摘要说明。 /// 作者： /// 时间： /// /summary 方法/属性 在方法的上方，必须写名方法的作用，作者，参数的说明，返回值的说明，以及如何使用。 格式如： /// summary /// 说明：方法的作用 /// 作者： /// 时间： /// /summary /// param name=param参数说明/param /// returns返回值说明/returns 变量注释 非IDE自动生成的变量，每声明一个变量，必须说明该变量的作用,//后空一格。 格式如： // 变量作用 Private int Variable; 功能/作用注释 一个方法内部,关键的语句前面，必须说明该语句做作用 命名规则 一般性原则： 一般的变量名称，用Pascal大小写原则,参数名称用Camel大小写原则 Pascal 大小写： 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如：BackColor Camel 大小写： 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 类命名 使用名词或名词短语命名类，体现类的作用。 不要使用下划线。 使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。如： NewDataGrid 当类只用于作为其他类的基类，以Base结尾Pascal大小写命名 参数命名 对参数名称使用 Camel 大小写 不要给参数名称加匈牙利语类型表示法的前缀 方法命名 使用动词或者短语 以Pascal大小写命名 属性命名 使用 Pascal 大小写。 不要使用匈牙利语表示法 考虑用与属性的基础类型相同的名称创建属性 事件命名 对事件处理程序名称使用 EventHandler 后缀 用 EventArgs 后缀命名事件参数类 指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参数始终是 object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类. 页面控件的命名页面控件命名时，按照类型加前缀，其命名方式类似Camel 大小写形式比如：txtUserName，btnSumbit，lblErrorInfo常量名通常全部采用单词的大写，单词之间以下划线“ _ ”隔开。private const bo