c# - c# 中类、函数、变量等的正确命名符号是什么？

Question

我是一名没有正式计算背景的网络开发人员，我已经编写代码几年了，但是每次我需要创建一个新的类/函数/变量时，我都会花大约两分钟的时间来决定一个名字然后是如何输入。

例如，如果我编写一个函数来总结一堆数字。我应该叫它吗

Sum()
GetSum()
getSum()
get_sum()
AddNumbersReturnTotal()

我知道有一种正确的方法可以做到这一点，我只需要一个指向良好权威来源的链接：D

score 5 · Accepted Answer

5

您正在寻找StyleCop。

于 2008-10-30T14:48:37.533 回答

score 3 · Accepted Answer

类应采用骆驼表示法，首字母大写

public class MyClass

C# 中的函数和方法应该以类似的方式运行，但私有方法除外

public void MyMethod()
private void myPrivateMethod()

我倾向于做一些不同的变量：

成员变量

private int _count;

局部变量

int count;

score 3 · Accepted Answer

我同意计算与获取的区别：get() 应该用于已经计算的值或以其他方式检索的微不足道的值。

此外，我建议在许多情况下在名称中添加一个名词，这样您计算的总和就很明显了。当然，除非您要添加的名词是类名或类型本身。

score 1 · Accepted Answer

上述所有的。

我相信官方 C# 指南会说调用它 calculateSum() 因为 getSum() 如果 sum 是一个实例变量将被使用。但这取决于所使用的编码风格以及项目中任何现有代码的编写方式。

score 0 · Accepted Answer

幸运的是，我不相信有一种标准化的方式可以做到这一点。我选择我喜欢的那个，因此它似乎也是我见过的所有其他源代码使用的标准，并使用它运行。

score 0 · Accepted Answer

Sum()如果它是公开的并且自己完成工作。

GetSum()如果它是公开的并且它从其他地方检索信息。

sum() / getSum() 同上，但用于内部/私有方法。

（嗯......这有点模糊，因为你稍微改变了“Sum”的意思。所以，让我们再试一次。

XXX如果 xxx 是一个过程（求和值）。 GetXXX如果 xxx 是一个东西。（值的总和）

score 0 · Accepted Answer

方法名称是动词。类、字段和属性名称是名词。在这种情况下，Sum可以作为动词或名词传递...

AddNumbersReturnTotal符合上述定义，但有点长。出于对维护我代码的人（通常是我！）的好意，我尽量避免在标识符中包含多余的单词，并且我尽量避免使用容易打错字的单词。

7 回答 7