编码风格-c#中类、函数、变量等的正确命名符号是什么
本文关键字:是什么 符号 -c# 风格 中类 函数 变量 编码 | 更新日期: 2023-09-27 17:47:46
我是一名web开发人员,没有正式的计算背景,我已经写代码好几年了,但每次我需要创建一个新的类/函数/变量时,我都会花大约两分钟的时间来决定一个名称,然后如何键入。
例如,如果我写一个函数来求一堆数字的和。我应该叫它吗
Sum()
GetSum()
getSum()
get_sum()
AddNumbersReturnTotal()
我知道有一种正确的方法可以做到这一点,我只需要一个链接到一个好的权威来源:D
作为c#编码标准/最佳实践的副本关闭
您正在寻找StyleCop。
类应该使用骆驼符号,第一个字母大写
public class MyClass
除了专用方法之外,C#中的函数和方法应该以类似的方式运行
public void MyMethod()
private void myPrivateMethod()
我倾向于做一些不同的变量:
成员变量
private int _count;
局部变量
int count;
我同意calculate与get的区别:get()应该用于已经计算或检索起来很琐碎的值。
此外,在许多情况下,我建议在名称中添加一个名词,这样你计算的总和就很明显了。当然,除非你要添加的名词是类名或类型本身。
以上所有内容。
我相信官方的C#指导方针会说,如果sum是一个实例变量,那么就会使用getSum(),所以称之为calculateSum(。但这取决于所使用的编码风格以及项目中任何现有代码的编写方式。
幸运的是,我不相信有标准化的方法可以做到这一点。我选择了一个我喜欢的,因此它似乎也是我见过的所有其他源代码使用的标准,并使用它运行
Sum()
,如果它是公共的并且自己完成工作。
GetSum()
,如果它是公共的并且它从其他地方检索信息。
sum()/getSum(),但适用于内部/私有方法。
(嗯……这有点模糊,因为你稍微改变了"answers"的意思。所以,让我们再试一次。
XXX
,如果xxx是一个过程(求和值)。GetXXX
如果xxx是一个东西。(值的总和)
方法名称是动词。类、字段和属性名称都是名词。在这种情况下,Sum
可以作为动词或名词传递。。。
AddNumbersReturnTotal
符合上述定义,但有点长。出于对维护我代码的人的善意(通常是我!),我尽量避免在标识符中包含多余的单词,也尽量避免容易在上拼写错误的单词。