c 编码规范(modified).docVIP

目 录 1 目的 1 2 范围 1 3 规范内容 1 3.1 代码格式 1 3.2 注释（Comme?nt）规范 2 3.2.1 模块（类）注释规范 2 3.2.2 类属性注释?规范 3 3.2.3 方法注释规?范 3 3.2.4 代码间注释?规范 3 3.3 变量（Varia?ble）命名规范 4 3.3.1 程序文件(*.cs)中的变量命?名规则 4 3.3.2 控件命名规?则 8 3.4 常量命名规?范 8 3.5 类（Class?）命名规范 9 3.6 接口（Inter?face）命名规范 9 3.7 方法（Metho?d）命名规范 9 3.8 命名空间（NameS?pace）命名规范 10 1 目的 为了保证企?业编写出的?程序都符合?相同的规范?，保证一致性?、统一性而建?立的程序编?码规范。 2 范围 适用于企业?所有基于.NET平台?的软件开发?工作。 3 规范内容 3.1 代码格式 所有的缩进?为4个空格?，使用VS.NET的默?认设置。 在代码中垂?直对齐左括?号和右括号?。 为了防止在?阅读代码时?不得不滚动?源代码编辑?器，每行代码或?注释在10?24*800的显?示频率下不?得超过一显?示屏。 当一行被分?为几行时，通过将串联?运算符放在?每一行的末?尾而不是开?头，清楚地表示?没有后面的?行是不完整?的。 每一行上放?置的语句避?免超过一条?。 在大多数运?算符之前和?之后使用空?格，这样做时不?会改变代码?的意图却可?以使代码容?易阅读。 将大的复杂?代码节分为?较小的、易于理解的?模块。 编写 SQL 语句时，对于关键字?使用全部大?写，对于数据库?元素（如表、列和视图）使用大小写?混合。 将每个主要?的 SQL 子句放在不?同的行上，这样更容易?阅读和编辑?语句，例如： SELEC?T First?Name, LastN?ame FROM Custo?mers WHERE? State? = WA 3.2 注释（Comme?nt）规范 注释规范包?括：模块（类）注释规范、类的属性、方法注释规?范、代码间注释? 3.2.1 模块（类）注释规范 模块开始必?须以以下形?式书写模块?注释： ///summa?ry ///模块编号：模块编号，可以引用系?统设计中的?模块编号 ///作用：对此类的描?述，可以引用系?统设计中的?描述 ///作者：作者中文名? ///编写日期：模块创建日?期，格式：YYYY-MM-DD ////summa?ry 如果模块有?修改，则每次修改?必须添加以?下注释： ///summa?ry ///Log编号?：Log编号?,从1开始一?次增加 ///修改描述：对此修改的?描述 ///作者：修改者中文?名 ///修改日期：模块修改日?期，格式：YYYY-MM-DD ////summa?ry 3.2.2 类属性注释?规范 在类的属性?必须以以下?格式编写属?性注释： /// summa?ry ///属性说明 /// /summa?ry 3.2.3 方法注释规?范 在类的方法?声明前必须?以以下格式?编写注释 /// summa?ry /// 说明：对该方法的?说明 /// /summa?ry /// param? name=参数名称参数说明/param? /// retur?ns ///对方法返回?值的说明，该说明必须?明确说明返?回的值代表?什么含义 /// /retur?ns 3.2.4 代码间注释?规范 代码间注释?分为单行注?释和多行注?释： 单行注释： //单行注释 多行注释： /*多行注释1? 多行注释2? 多行注释3?*/ 代码中遇到?语句块时必?须添加注释?（if,for,forea?ch,……）,添加的注释?必须能够说?明此语句块?的作用和实?现手段（所用算法等?等）。 3.3 变量（Varia?ble）命名规范 3.3.1 程序文件(*.cs)中的变量命?名规则 程序中变量?名称 = 变量的前缀? + 代表变量含?意的英文单?词或单词缩?写。 1.类模块级的?变量请用“m_”作前缀 publi?c class? Hello? { priva?te strin?g m_Nam?e; priva?te DateT?ime m_Dat?e; } 2.类的属性所?对应的变量?，采用属性名?前加“m_”前缀的形式? publi?c class? Hello? { priva?te strin?g m_Nam?e; publi?c strin?g Name { get { retur?n m_Nam?e; } } } 3.方法的变量?不使用前缀? publi?c class? Hello? { void Say() { strin?g SayWo?rd; }