C#编码标准--命名约定和风格

原创 2004年03月08日 11:28:00
命名约定和风格
1. 使用Pascal的命名规范命名类型和方法的名字。
public class SomeClass
{
    public SomeMethod(){}
}
2. 使用camel命名规范命名局部变量和方法的参数。
int number;
void MyMethod(int someNumber)
{}
3. 在命名接口的时候使用I作为前缀。
interface IMyInterface
{...}
4. 私有成员变量使用m_作为前缀。
public class SomeClass
{
   private int m_Number;
}
5. 自定义的属性类使用Attribute作为其后缀。
6. 自定义的异常类使用Exception作为其后缀。
7. 在命名方法的时候使用动宾结构的短语,比如:ShowDialog()。
8. 有返回值的方法应该有一个可以描述其返回值的名字,比如:GetObjectState()。
9. 使用有意义的变量名称。
10. 使用C#的预定义的类型而不使用System命名空间中其别名来申明变量。
使用object 而不是 Object
使用string 而不是 String
使用 int 而不是 Int32
11. 通常情况下,类型使用大写字母。当处理.NET的类型的时候使用Type作为其后缀。
//正确的是:
public class LinkedList<K,T>
{…}
//避免使用:
public class LinkedList<KeyType,DataType>
{…}
12. 使用有意义的命名空间,比如使用公司的名称以及产品的名称。
13. 避免使用完全限定名。而使用using语句替换之。
14. 避免将using语句写在命名空间的内部。
15. 将所有的框架定义的命名空间为一组,自定义的和第三方的命名空间放在另一组。
using System;
using System.Collections.
using System.ComponentModel;
using System.Data;
using MyCompany.
using MyControls;
16. 使用委托的引用替换显式的委托实例。
delegate void SomeDelegate();
public void SomeMethod()
{…}
SomeDelegate someDelegate = SomeMethod;
17. 保持严格的缩进风格。
a. 使用3个空格缩进
b. 不要使用tabs或者其他不标准的缩进,比如1、2、4个空格。
18. 在编写注释的时候注释的缩进和编码的缩进必须是相同级别的。
19. 所有的注释都要通过拼写检查,错误的拼写是粗糙的开发。(针对汉语则要语句通顺易于理解)
20. 所有的成员变量都应该声明在顶部,同时使用一个空行来将他们和属性以及方法分开。
public class MyClass
{
   int m_Number;
   string m_Name;
  
   public void SomeMethod1()
{}
   public void SomeMethod2()
{}
}
21. 尽可能在第一次使用局部变量的时候申明它。
22. 文件名称应该可以反映出它所包含的类。
23. 当使用不完整的类并且将部分分配到每个文件中,用P+序数作为后缀命名文件。
// in myClassP1.cs
public partial class MyClass
{…}
// in myClassP2.cs
public partial class MyClass
{…}
24. 总是将大括号放在一个新行上。
25. 匿名方法和一般(正规)的方法代码使用相似的代码布局
a. 规定:大括号(方法体的括号)必须使用新行
delegate void SomeDelegate(string someString);
// 正确的是:
public void InvokeMethod()
{
   SomeDelegate someDelegate = delegate(string name)
{
   MessageBox.Show(name);
};
   someDelegate(“Juval”);
}
// 避免使用:
public void InvokeMethod()
{
   SomeDelegate someDelegate = delegate(string name){ MessageBox.Show(name);};
   someDelegate(“Juval”);
}
26. 在匿名无参方法中要使用空的括号。
a. 如果匿名方法有可能被使用在任何委托中那么可以省略括号。
delegate void SomeDelegate();
// 正确的方法是:
SomeDelegate someDelegate1 = delegate()
         {
                              MessageBox.Show(“Hello”);
}
 // 避免使用:
 SomeDelegate someDelegate1 = delegate
          {
                               MessageBox.Show(“Hello”);
}

C++编码规范之命名约定

公司内部有一份代码规范,感觉还是很有帮助的,简单列一下C++规范中的核心部分,必要的加一些自己的理解和实际编码过程中遇到的问题与感受,很多细节的说明就不一一翻译了,能够明白就行。 第一部分:命名约定...
  • cisse
  • cisse
  • 2014年02月08日 22:07
  • 662

Google 编码风格之命名规范(备忘)

参考链接:http://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/naming/ 通用规则:所有函数、...
  • Firehotest
  • Firehotest
  • 2016年07月22日 14:02
  • 3167

C#编码风格小总结

最近连续使用了3个月时间的C#,对C#的类库基本可以驾轻就熟的应用了,在这段时间里也总结出了合适的编程风格,最近刚刚写完了一个网络状态监测的小程序,自认为风格可以代表自己的编程风格,主要单元全部贴出来...
  • wikiccc
  • wikiccc
  • 2014年01月23日 23:39
  • 827

C#命名规则和风格

1.文件命名组织 1-1文件命名 1.文件名遵从Pascal命名法,无特殊情况,扩展名小写。 2.使用统一而又通用的文件扩展名: C# 类 .cs 1-2文件注释 1. 在每个文件头必须包含以...
  • 3150379
  • 3150379
  • 2017年03月26日 15:23
  • 482

关于编程命名规则与代码风格

1. 编程命名规则没有一种命名规则是所有人都赞同的,在这里,我们只是把常用的命名规则罗列出来,然后从中找出适合shell编程和便于理解的规则作为我们的命名规则。当然,我们不会只推荐一种,我们会推荐一两...
  • bitterliquor
  • bitterliquor
  • 2013年11月08日 13:27
  • 1044

编码风格一:如何取好变量名

代码的可读性好坏,会影响到程序员编写和维护代码的过程。如果把人的大脑看作计算机 CPU 加上内存的结合。那么,需要人去猜测的变量名、没有良好组织结构的代码、混乱的布局,对于阅读代码的人来说,总会消耗过...
  • very9527
  • very9527
  • 2015年07月09日 10:08
  • 880

Android 命名规范和编码规范(尽力简单,多写注释)

一、制定规范不需要太多的理论知识,只要记住两点就够了:尽力简单,多写注释 二、登录页面的登录按钮命名: login_button(资源文件) btnLogin(java代码中的按...
  • yaoming168
  • yaoming168
  • 2016年07月22日 19:40
  • 1333

JavaScript编码风格约定

如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低。因此,如果项目中有多人参与,采取一个有共识的编码风格约定非常有必要。与其他...
  • ceoshun
  • ceoshun
  • 2014年06月12日 20:42
  • 627

C#编码标准和命名规范

以下是C#编码标准,命名规范,还有一些最佳实践。 在你的项目里使用这些规范和(或者)调整这些适应你的需求。 类型名称和方法名称使用PascalCasing书写 public class Cl...
  • panliuwen
  • panliuwen
  • 2015年09月03日 09:24
  • 2292

C++ 变量命名约定和风格

1、 变量名只能是字母(A-Z,a-z)和数字(0-9)或者下划线(_)组成。 2、 第一个字母必须是字母或者下划线开头。 3、 不能使用C++关键字来命名变量,以免冲突。 4、 变...
  • nibiru_holmes
  • nibiru_holmes
  • 2016年06月02日 18:07
  • 179
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:C#编码标准--命名约定和风格
举报原因:
原因补充:

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