命名类操作的约定？

Question

您使用什么约定来命名类操作？

Answer 1

完整文档：下载 C# 编码标准和标准最佳实践

命名约定和标准

注意：
本文档中使用术语 Pascal Casing 和 Camel Casing。
帕斯卡大小写 - 所有单词的第一个字符均为大写，其他字符均为小写。
示例：背景颜色
Camel Casing - 所有单词的第一个字符，除了第一个单词是大写，其他字符都是小写。
示例：backColor

1. 对类名使用 Pascal 大小写

   公共课HelloWorld
   {
   ...
   }

2. 方法名称使用 Pascal 大小写

   void SayHello（字符串名称）
   {
   ...
   void

3. 变量和方法参数使用驼峰式大小写

   int 总数 = 0;
   void SayHello（字符串名称）
   {
   字符串 fullMessage = "你好" + 姓名;
   ...
   }

4. 在接口中使用前缀“I”和驼峰式命名法（示例：IEntity）

5. 不要使用匈牙利表示法来命名变量。

早期，大多数程序员都喜欢它 - 将数据类型作为变量名的前缀，并使用 m_ 作为成员变量的前缀。例如：

字符串m_sName；
int nAge；

但是，在 .NET 编码标准中，不建议这样做。不应使用数据类型和 m_ 来表示成员变量。所有变量都应使用驼峰式大小写。

一些程序员仍然喜欢使用前缀 m_ 来表示成员变量，因为没有其他简单的方法来标识成员变量。

1. 使用有意义的描述性词语来命名变量。不要使用缩写。

好：

string address
int salary 

不好：

string nam
string addr
int sal 

1. 不要使用单字符变量名称，如 i、n、s 等。使用索引、temp 等名称

。这种情况下的一个例外是用于循环中迭代的变量：

for ( int i = 0; i < count; i++ )
{
 ...
}

如果该变量仅用作计数器尽管迭代并且不在循环中的其他任何地方使用，但许多人仍然喜欢使用单个 char 变量 (i)，而不是发明一个不同的合适名称。

1. 局部变量名请勿使用下划线 (_)。

2. 所有成员变量都必须带有下划线（_）前缀，以便与其他局部变量识别。

3. 不要使用类似于关键字的变量名称。

4. 为布尔变量、属性和方法添加“is”或类似前缀。

例如： private bool _isFinished

1. 命名空间名称应遵循标准模式

...

1. 为 UI 元素使用适当的前缀，以便您可以从其余变量中识别它们。

这里推荐两种不同的方法。

一个。对所有 UI 元素使用通用前缀 ( ui_ )。这将帮助您将所有 UI 元素组合在一起，并轻松从智能感知中访问所有这些元素。

b.为每个 ui 元素使用适当的前缀。下面给出了一个简短的列表。由于 .NET 提供了多个控件，因此您可能必须为您正在使用的每个控件（包括第三方控件）获取标准前缀的完整列表。

Control Prefix
Label lbl
TextBox txt
DataGrid dtg
Button btn
ImageButton imb
Hyperlink hlk
DropDownList ddl
ListBox lst
DataList dtl
Repeater rep
Checkbox chk
CheckBoxList cbl
RadioButton rdo
RadioButtonList rbl
Image img
Panel pnl
PlaceHolder phd
Table tbl
Validators val

1. 文件名应与类名匹配。

例如，对于 HelloWorld 类，文件名应为 helloworld.cs（或 helloworld.vb）

1. 使用 Pascal Case 命名文件名。

2. 缩进和间距

3. 使用TAB 进行缩进。不要使用空格。将制表符大小定义为 4。

4. 注释应与代码处于同一级别（使用相同的缩进级别）。

好：

// Format a message and display

string fullMessage = "Hello " + name;
DateTime currentTime = DateTime.Now;
string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show ( message );

不好：

// Format a message and display
string fullMessage = "Hello " + name;
DateTime currentTime = DateTime.Now;
string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show ( message );

1. 大括号 ( {} ) 应与大括号外的代码处于同一级别。

2. 使用一个空行来分隔逻辑代码组。

好：

 bool SayHello ( string name )
 {
  string fullMessage = "Hello " + name;
  DateTime currentTime = DateTime.Now;

  string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();

  MessageBox.Show ( message );

  if ( ... )
  {
   // Do something
   // ...

   return false;
  }

  return true;
 }

不好：

bool SayHello (string name)
 {
  string fullMessage = "Hello " + name;
  DateTime currentTime = DateTime.Now;
  string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
  MessageBox.Show ( message );
  if ( ... )
  {
   // Do something
   // ...
   return false;
  }
  return true;
 }

1. 类中的每个方法之间应该有且只有一个空行。

2. 大括号应该在单独的行上，而不是在同一行，如 if、for 等。

好：

if ( ... ) 
  {
   // Do something
  }

不好：

if ( ... ) {
   // Do something
  }

1. 在每个运算符和括号之前和之后使用一个空格。

好：

if ( showResult == true )
  {
   for ( int i = 0; i < 10; i++ )
   {
    //
   }
  }

不好：

if(showResult==true)
  {
   for(int    i= 0;i<10;i++)
   {
    //
   }
  }

1. 使用#region 将相关的代码片段分组在一起。如果您使用 #region 进行正确的分组，那么当所有定义都折叠时，页面应该像这样。

2. 将私有成员变量、属性和方法保留在文件顶部，将公共成员保留在底部。

Answer 2

我发现使用您正在使用的语言和框架所使用的相同命名约定可以让每个人的生活变得更轻松。

例如，.Net 有一个 约定。对你的语言的功能进行建模，你的代码和库的“用户”会更高兴。所以，答案可能是，这取决于您的语言和/或平台......

Answer 3

命名约定是一个有争议的话题，因为它是一种任意的区别。

上面两个答案都很好。我的补充是：

你的目标是可读性。你的代码讲述了一个故事，尽管有时有点无聊。确保故事清晰。

如需更多乐趣，请参阅以下链接：

http://www.joelonsoftware.com/articles/Wrong.html< /a>

http://en.wikipedia.org/wiki/Naming_convention_%28programming%29< /a>