What is the correct naming notation for classes, f

问题:

I'm a web developer with no formal computing background behind me, I've been writing code now some years now, but every time I need to create a new class / function / variable, I spend about two minutes just deciding on a name and then how to type it.

For instance, if I write a function to sum up a bunch of numbers. Should I call it

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

I know there is a right way to do this, and a link to a good definitive source is all I ask :D

Closed as a duplicate of c# Coding standard / Best practices

回答1:

Classes should be in camel notation with the first letter capitalized

public class MyClass

Functions and Methods in C# should act in a similar fashion except for private methods

public void MyMethod()
private void myPrivateMethod()

Variables I tend to do a little differently:

Member Variables

private int _count;

Local variables

int count;

回答2:

You're looking for StyleCop.

回答3:

I agree on the calculate vs get distinction: get() should be used for values that are already calculated or otherwise trivial to retrieve.

Additionally, I would suggest in many cases adding a noun to the name, so that it's obvious exactly what sum you are calculating. Unless, of course, the noun you would add is the class name or type itself.

回答4:

All of the above.

I believe the official C# guidelines would say call it calculateSum() as getSum() would be used if the sum was an instance variable. But it depends on the coding style used and how any existing code in the project is written.

回答5:

Luckily enough I don't believe there is a standardized way this is done. I pick the one that I like, which consequently also seems to be the standard all other source code I've seen uses, and run with it.

回答6:

Sum() if it's public and does the work itself.

GetSum() if it's public and it retrieves the information from somewhere else.

sum() / getSum() as above, but for internal/private methods.

(Hmm... That's a bit vague, since you shift the meaning of "Sum" there slightly. So, let try this again.

XXX if xxx is a process (summing values). GetXXX if xxx is a thing. (the sum of the values)

回答7:

Method names are verbs. Class, field and property names are nouns. In this case, Sum could pass as either a verb or a noun...

AddNumbersReturnTotal fits the above definition, but it's a little long. Out of kindness to the guy who gets to maintain my code (usually me!) I try and avoid including redundant words in identifiers, and I try to avoid words that are easy to make typos on.