.NET简明编码规范

转载 2004年07月30日 09:36:00
 

.NET简明编码规范
  ——Extracted from “.NET Framework General Reference
  Design Guidelines for Class Library Developers”
  版本:V1.0

  1 Namespace 命名规范

  使用 公司名.产品名 这样的格式。
  Namespace中类的依赖关系应该体现在命名上,比如System.Web.UI.Design中的类以来于System.Web.UI。
  使用 Pascal case 命名。
   当商标(产品名)的命名风格和Pascal case不相符的时候,以商标(产品名)为准。
  在语意合适的情况下使用复数,比如System.Collections。例外是缩写和商标的情况。
  Namespace的名字不一定和Assembly一一对应。

  2 Class 命名规范

     使用名词或者名词性词组命名class。
     使用 Pascal case。
     保守地使用缩写。
     不使用type前缀,例如C来标识Class。比如,使用FileStream而不是CFileStream。
     不使用下划线。
     偶尔的在Class名称组成中需要使用I开头的时候,比如IdentityStore,just use it。
     在合适的时候,使用单词复合来标识从某个基类继承而来。比如xxxException。

  3 Interface 命名规范

     使用名词或者名词性词组命名Interface。
     使用 Pascal case。
     保守地使用缩写。
     在interface 名称前加上字母I来表示type是interface。
     在某个class是某个interface地标准实现地时候,用类似的名字来命名它们,仅仅在interface的名称前面多个I。
     不要使用下划线。

  4 Attribute 命名规范

     总是给Attribute类加上Attribute后缀。

  5 Enumeration Type 命名规范

     对Enum类型和值使用Pascal case。
     不要在Enum类型名称后面加上Enum后缀。
     对于大多数Enum类型使用单数名称,仅仅在这个Enum类型是bit fields地时候使用复数形式。
     总是给bit field Enum 类型添加FlagsAttribute。

  6 Static Field 命名规范

     使用名词、名词性词组或者名词地缩写来命名static fields。
     使用Pascal case。
     不要在static field名称中使用匈牙利命名法。
     在任何可能的情况下推荐你使用静态properties而不是public static fields。

  7 Parameter 命名规范

     对于parameter名称使用camel case。
     使用描述性的名称。参数名字应该在大多数场合下它的名字加上类型足够描述它的意义。
     使用描述参数的意义的名字而不是描述参数类型的名字。开发工具应该提供有关参数类型的有意义的信息。因而,参数的名字可以用于更好的描述意义。保守地使用基于类型的参数名字,仅仅在它们是合适的场合下使用。
     不要使用保留的参数。
     不要使用匈牙利命名法。

  8 Method 命名规范

     使用动词或者动词性词组命名。
     使用Pascal case。

  9 Property 命名规范

     使用名词或者名词性词组命名。
     使用Pascal case。
     不要使用匈牙利命名法。
     考虑使用和property type名字相同的名字作为property name。

  10 Event 命名规范

     使用Pascal case。
     不要使用匈牙利命名法。
     在event handler名字中使用EventHandler后缀。
     指定两个名字分别为sender和e的参数。sender参数代表了发出事件的对象。sender参数总是类型object,即使可能使用一个更加精确的类型。和事件相关的状态封装在名字为e的event class的实体之中。给e指定恰当而且明确的event class。
     使用EventArgs后缀命名事件参数class。
     考虑使用动词命名事件。使用进行时态来标识事件正在进行之中,使用完成时态标识事件已经完成,不要使用BeforeXxx/AfterXxx命名法。
     不要在事件声明中使用前缀和后缀,比如,用Close而不是OnClose。
     一般的,你应该同时提供一个名字为OnXxx的protected method供派生类来改写。

.NET代码规范检测-StyleCop使用规则

在StyleCop中有一些官方自己写好的检测规则下面就是英文的解释 文档规则 1、SA1600:ElementsMustBeDocumented元素必须添加注释 ...
  • yang_mysky
  • yang_mysky
  • 2014年07月29日 13:50
  • 739

.NET 编码规范(一)

1、命名约定与规范 注意: 在本文档中使用了帕斯卡命名法(PascalCasing)与驼峰命名法(Camel Casing)。 帕斯卡命名法 – 所有单词的首字母大写,其余的字母小写。 实例:Bac...
  • Haohan_Meng
  • Haohan_Meng
  • 2015年09月23日 22:17
  • 559

华为编码规范

1 排版 ¹ 1-1:程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 ¹ 1-2:相对独立的程序块之间、变量说明之后必须加空行。 示例:如下例...
  • marric
  • marric
  • 2016年12月09日 22:51
  • 896

标准的Java编码规范手册

编码规范体现出一个开发者的基本素质,良好的编码规范可以提高团队编码的效率,避免很多不必要的问题。今天分享一个标准的Java编码规范给大家,希望对于大家今后的开发工作带来帮助。编码规范的意义     ...
  • mynameishuangshuai
  • mynameishuangshuai
  • 2016年05月10日 17:21
  • 12837

JavaScript编码规范

1 前言 JavaScript在百度一直有着广泛的应用,特别是在浏览器端的行为管理。本文档的目标是使JavaScript代码风格保持一致,容易被理解和被维护。 虽然本文档是针对JavaScript...
  • u012906135
  • u012906135
  • 2016年06月13日 11:04
  • 1087

Google JavaScript 编码规范指南

JavaScript 语言规范 变量 link ▽ 声明变量必须加上 var 关键字. Decision: 当你没有写 var, 变量就会暴露在全局上下文中, 这样很可能会和现...
  • xianghongai
  • xianghongai
  • 2015年05月18日 20:04
  • 2713

Java编码规范(常用重点)

1、Java源文件1.1、注释所有的源文件都应当在开头有一个注释,此中列出类名、版本信息、日期和版本声明,具体可以参考我的博客:Java注释模版设置1.2、包和引入语句大部分java源文件中,第一行非...
  • u013249965
  • u013249965
  • 2016年07月02日 21:32
  • 897

.NET设计规范————命名规范

NET设计规范:约定、惯用法与模式前言:         最近在看《.NET设计规范:约定、管用法与模式》一书,主要还是讲.NET的设计规范,以前对这一块也不是特别在意,最近想要把这些系统的学习一下,...
  • xuemoyao
  • xuemoyao
  • 2016年03月27日 17:11
  • 3013

官方Java编码规范

[Coding Style]官方Java编码规范 原文地址 http://www.cesclub.com/bw/jishuzhongxin/xiangmuyanfaguanli/201...
  • ccccdddxxx
  • ccccdddxxx
  • 2016年06月01日 15:20
  • 1400

google c++ 编码规范

1. 命名约定 最重要的一致性规则是命名管理. 命名风格快速获知名字代表是什么东东: 类型? 变量? 函数? 常量? 宏 ... ? 甚至不需要去查找类型声明. 我们大脑中的模式匹配引擎可以非常可靠...
  • xiexievv
  • xiexievv
  • 2016年03月24日 16:55
  • 6152
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:.NET简明编码规范
举报原因:
原因补充:

(最多只允许输入30个字)