c#中类,函数,变量等的正确命名符号是什么?

时间:2008-10-30 14:47:41

标签: c# coding-style naming-conventions

我是一名没有正式计算背景的网络开发人员,我现在已经编写代码了几年,但每次我需要创建一个新的类/函数/变量时,我花了大约两分钟才决定在名称上,然后如何键入它。

例如,如果我写一个函数来总结一堆数字。我应该打电话吗

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

我知道有一种正确的方法可以做到这一点,我要问的是一个关于良好权威来源的链接:D

作为c# Coding standard / Best practices

的副本关闭

7 个答案:

答案 0 :(得分:5)

您正在寻找StyleCop

答案 1 :(得分:3)

类应该是骆驼符号,首字母大写

public class MyClass

C#中的函数和方法应该以类似的方式起作用,除了私有方法

public void MyMethod()
private void myPrivateMethod()

变量我倾向于做一些不同的事情:

会员变量

private int _count;

局部变量

int count;

答案 2 :(得分:3)

我同意计算与得到的区别:get()应该用于已经计算过的值或者很容易检索的值。

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

答案 3 :(得分:1)

以上所有。

我认为官方C#指南会称之为computeSum(),因为如果sum是实例变量,则会使用getSum()。但这取决于所使用的编码风格以及项目中现有代码的编写方式。

答案 4 :(得分:0)

幸运的是,我不相信这是一种标准化的方式。我选择了我喜欢的那个,因此它似乎也是我见过的所有其他源代码的标准,然后运行它。

答案 5 :(得分:0)

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

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

sum()/ getSum()如上所述,但是对于内部/私有方法。

(嗯......这有点模糊,因为你稍微改变了“Sum”的含义。所以,让我们再试一次。

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

答案 6 :(得分:0)

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

AddNumbersReturnTotal符合上述定义,但有点长。对于那些维护我的代码的人(通常是我!),我试图避免在标识符中包含多余的单词,并且我尽量避免使用易于拼写错误的单词。