的代码样式要求摘要 网络项目

PDF下载：项目代码风格需要V1.0.pdf。

代码是否正确，重要的是统一性。这是我提出的《.Net 项目代码风格要求》的复印件，供大家参考。

1.C#代码风格要求1.1注意事项。

类型、属性、事件、方法和方法参数，并根据需要添加注释。

如果类型、属性、事件、方法和方法参数的名称是不言自明的，则不需要注释。否则，您需要添加注释。

添加注释时，添加方法如下图所示：

1.2类型(类、结构、委托、接口)、字段、属性、方法和事件的命名。

优先考虑英语。如果没有合适的英文单词描述，可以用拼音。用中文达不到要求。

唯一可以使用中文的地方是枚举的枚举项，其实不属于本节标题的范畴。只需将它们放在这里，如下图所示：

1.3不要使用缩写。

所有类型、方法、参数和变量都不能用缩写来命名，包括众所周知的缩写，如msg。

1.4代码使用半展开。

第一步：打开Visual Studio，进入工具和选项，如下图所示：

第二步：输入文本编辑器、C#、格式设置、新建行，取消右侧所有复选框中的复选标记，如下图：

第三步：点击确定完成设置。

1.5使用制表符作为缩进，并将缩进大小设置为4。

第一步：打开Visual Studio，进入工具和选项，如下图所示：

第二步，进入“文本编辑器”、“C#”、“选项卡”，设置选项卡如下图所示。

第三步：点击确定完成设置。

1.6 a. cs源文件最多定义两种类型。

如果这两种类型之间的关系密切，例如Product和producttype，那么可以在同一个Product.cs文件中定义产品类和ProductType枚举。

但是，两个不相关的类型定义不能出现在. cs文件中，例如，产品类和经销商类(分销商)是在一个基本信息. cs文件中定义的。

1.7类型名和源文件名必须一致。

当一个类型被命名为产品时，它的源文件名只能是产品

1.8所有名称空间和类型名称都使用Pascal样式(单词的首字母大写)。

如下图所示，红色标记的类型是Pascal样式：

请注意，ProductType是私有类型。无论类型是公共的还是私有的，它的名字总是采用Pascal风格。

1.9局部变量和方法参数的名称使用Camel样式(第一个字母小写，后面每个单词的第一个字母大写)。

用红色标记的是使用Camel样式的变量或方法参数：

1.10私有方法和受保护方法仍然以Pascal风格命名。

示例代码如下：

1.11如果if语句中只有一行，可以留大括号，但必须和if语句在同一行。

示例1.9中的if判断实际上相当于以下语句：

1.12调用类型内的其他成员，需要添加这个；若要调用父类成员，请添加基类。

示例代码如下：

1.13该类型中的私有和受保护字段以Camel样式命名，但前缀为“_”。

代码示例如下：

1.14公共字段不能出现。

如果需要公共字段，请用属性包装它们。

1.15型构件的排列顺序。

成员从上到下的排列顺序为：

字段：私有字段、受保护字段。

属性：私有属性、受保护属性和公共属性。

事件：私人事件、受保护事件和公共事件。

构造函数：参数个数最多的构造函数，参数个数中等的构造函数，参数个数最少的构造函数。

方法：重载方法的排列顺序与构造函数相同，从最多的参数到最少的参数。

1.16委托和事件的命名。

委托是以事件处理程序命名的，例如SalesOutEventHandler。

该事件是通过删除事件处理程序后缀并将“开”前缀添加到其相应的委托类型中而形成的。

例如，对于SalesOutEventHandler委托类型的事件，其事件名称为：OnSalesOut。

示例代码如下：

1.17返回bool类型的方法和属性的名称。

如果方法返回的类型是布尔类型，则它的前缀是“可以”或“尝试”，例如：

1.18常见集合类型的后缀命名。

如果满足下表中列出的收集类型，则应添加相应的后缀。

解释后缀示例数组Array int[]productArray list list list product list datatable/hashtable hashtable product table Dictionary system ring，字符串productDictionary EF中dbset/数据集集合dbset product set 1.19的公共后缀命名。

下表中列出的所有局部变量、方法参数、字段和属性应添加相应的后缀。

解释后缀示例示例解释费用相关装运成本运输成本价格相关价格产品单价价格产品单价消息相关消息(已弃用注意)成功消息日期相关日期(已弃用时间)订购日期订购日期计数、数量相关计数(已弃用时间)登录次数链接地址相关Url BlogUrl博客链接图片相关图像签名图片金额相关金额预装、积分相关积分会员积分记录， 相关日志(已弃用日志)错误记录错误记录配置相关配置数据库配置数据库状态相关状态订单状态模式和模式相关模式打开模式类型相关类别/类型，用户类别，用户类别，工厂类，工厂连接工厂连接，已启用，已启用导出已启用，已启用，导出流，上传流，上传流，读取器，excel读取器e. Xcel读取器写入器相关写入器ExcelWriter Excel写入器适配器相关适配器IntroOPAdapter IntroOP适配器提供器相关提供器MemebershipProvider成员信息提供器包装器相关产品包装器。 Er产品包装器连接相关连接Excel连接Excel连接1.20常见类型命名。

下表中的任何类型都应使用下表中指定的名称命名。

类型命名类型命名客户分销商经销商零售商零售商经销商/批发商用户用户信息(用户是数据库键)订单订单信息(订单是数据库键)供应商供应商管理员密码成员评论文章新闻新闻发票。发票进出口出口公司，公司产品省市市区区地址地址角色角色权限仓库工厂工厂登录日志。登录(放弃登录)注销(放弃注销)创建创建(放弃添加)编辑更新更新删除(放弃删除)照片图像1.21常见字段和属性的命名。

字段和属性的类型很复杂，因此只列出最常用的项目。

类型类型名称Id(int Type)Id(“d”小写，不推荐使用的ID) GuidId(Guid类型)Id名称标题备注，说明(不推荐使用的备忘录，说明)类别类别(不推荐使用的类，类型)联系人2。XHTML代码风格要求2.1如果XHTML标记有层次，那么代码也应该有层次。

以下是符合要求的写作示例：

以下是不符合要求的写作示例：

2.2所有标记必须关闭。

示例代码如下：

2.3如果标记的中间代码超过20行，应在标记的末尾添加标记。

标记方法如下：

3.CSS代码样式要求3.1代码使用半扩展。

设置方法参见第1.4节。

3.2使用制表符作为缩进，并将缩进大小设置为4。

设置方法参见第1.5节。

3.3代码注释。

注释主要解释样式应用于页面的哪个部分，而不是样式的应用效果。代码注释样式如下：

3.4代码编写。

每个样式设置都必须有一条专用线，不能位于同一条线上。以下是符合要求的文字：

以下不符合写作要求：

3.5嵌入样式的比例不得超过样式表总代码的10%。

嵌入样式是直接写在HTML标签内部的样式，如下图所示：

3.6内嵌样式的比例不得超过样式表总代码的30%。

内嵌样式是用head/head写的样式，如下图所示：

内联样式不能写在正文/正文之间。

3.7外部样式表的比例不低于样式表总代码的60%。

外展样式表是用。css文件并通过链接引入到XHTML页面中，如下图所示：

4.JavaScript代码风格要求4.1代码使用半扩展。

设置方法参见第1.4节。

4.2使用制表符作为缩进，并将缩进大小设置为4。

设置方法参见第1.5节。

4.3代码注释。

注意事项需要说明“功能函数”、“入口参数”和“返回值”。注释示例如下：

第一行描述功能；第二行描述入口参数；最后一行描述返回值。

4.4不得出现嵌入式代码。

嵌入式代码是指用XHTML标记编写的JavaScript代码，以下编写不符合要求：

4.5 JavaScript内联代码总量不得超过40%。

内联代码是指写在头/或体/之间的代码：

4.6外联代码至少占JavaScript的60%。

外展代码是指用单独的。然后通过脚本标签连接到XHTML页面。

感谢您的阅读，希望这篇文章对您有所帮助！