Shulou(Shulou.com)06/02 Report--

This article mainly explains "what are the naming conventions of C#". Interested friends may wish to take a look. The method introduced in this paper is simple, fast and practical. Next, let the editor take you to learn "what are the naming conventions of C#"?

In the example of C# project development, it is a very important requirement for the formulation of specifications. Reasonable method names and appropriate names are the standard contents of C# project development examples, which can greatly improve the maintainability and robustness of the system, and make the system relationship clear.

The naming convention with clear meaning is the core of program planning. If all the names of the whole system are suitable for its function, and people can "hope to know the meaning", such as "Age" and "SetAge ()", it can greatly improve the maintainability and robustness of the system, and make the relationship of the system clear. On the other hand, if the naming does not reflect its meaning, such as "v001", "f002 ()", it will be counterproductive.

Description

The common naming styles are as follows.

(1) Pascal style: contains one or more words, each word has uppercase letters, the other letters are lowercase, and the rest are lowercase. For example: CollegeStudent, HelloWorld, etc.

(2) Camel style: contains one or more words, * the first letter of the word is lowercase, the first letter of the other words is uppercase, and the other letters are lowercase. For example: name, gender, somePara, etc.

Here are some commonly used naming conventions for readers' reference in development.

1. Namespace

Namespaces are named in Pascal style, and the general rules for naming are as follows.

CompanyName.TechnologyName

For example:

Microsoft.Office

MyCompany.NamingRule.Test

In addition, use the plural namespace name when you need to use the plural. For example, use System.Collections instead of System.Collection. However, when it comes to abbreviations, it is usually not necessary to use the plural. For example: use System.IO instead of System.IOs.

Namespaces and classes cannot use the same name. For example, after a class is named Student, do not use Student as a namespace.

2. Class

The class naming in C # uses the Pascal naming style, and the rules for naming are as follows.

(1) before naming a class, you should first know the role of the class, naming it with a noun or noun phrase as far as possible, so that programmers can understand the basic functions of the class through the clues provided by the class name.

(2) try not to use abbreviations, but use full writing. For example: use CollegeStudent instead of CollegeStu.

(3) do not use any class prefixes (e.g. C) and suffixes (e.g. Class).

(4) do not use underlined characters (such as College_Student).

The following is an example of a reasonable class name.

Code 19-1 class naming example

/ / Class name: Pascal naming style, shaped like SomeClass. / pulibc class CollegeStudent {… }

3. Private member

The member variables of the class are in the style of Camel and use the prefix m _ or _. Here are some examples of reasonable private members.

Code 19-2 example of private member naming

Class CollegeStudent {/ Private member naming: Camel naming style, shaped like member. / private string masks name; private int mages;}

In addition, some programmers are used to using data type prefixes to determine the data type of parameters. For example, strName, nAge, etc., but this is not a general specification.

4. Attribute

The properties of the class are in Pascal style. Here are some reasonable examples of properties.

Code 19-3 example of attribute naming

Class CollegeStudent {/ attribute naming: Pascal naming style, shaped like Name. / / public string Name {set {if (valueworthy null) this.m_name=value;} get {return this.m_name;}}

5. Methods

Usually each method is an "action" of the execution class, so the naming of the method should clearly indicate what the method does, and this meaning can be expressed more clearly with the structure of "verb + noun". For example, replacing Info () with ShowInfo () and DataLoad () with LoadData () is intended to clarify the functionality of this method.

Here are some examples of reasonable method names.

Code 19-4 method naming example

Class CollegeStudent {/ method name: Pascal naming style, shaped like SomeMethod. / public void EnterSchool () {… }}

In addition, some prefixes are often used to express the meaning of the method, as follows.

(1) Is means to ask a question about something. For example: IsMale ().

(2) the meaning of Get is to get a value. For example: GetInfo ().

(3) the meaning of Set is to set a value. For example: SetInfo ().

6. Method parameters

In C #, the parameters of the method are in camel style. In addition, some programmers are used to using data type prefixes to determine the data type of parameters. For example, strName, nAge, etc.

The following are some C# project development examples named by method parameters.

Code 19-5 method parameter naming C# project development example

Class CollegeStudent {public void SetInfomation (string name,int age) {… }}

7. Interface

Similar to the method, the interface adopts the Pascal naming convention, and the rules for naming are as follows.

(1) use I as a prefix to indicate that it is an interface.

(2) use nouns or noun phrases, or adjectives that describe behavior, to name interfaces. For example, IComponent (descriptive noun), ICustomAttributeProvider (noun phrase), and IPersistable (adjective).

(3) try not to use abbreviations, but use full writing. For example: use IComponent instead of IComp.

(4) do not use underlined characters (such as ICustom_AttributeProvider).

For example:

Code 19-6 interface naming example

Class CollegeStudent {/ API name: Pascal naming style, shaped like ISomeInterface. / public interface IPlay {};}

8. Variables

Local variables are camel-style, and try to use descriptive nouns or noun phrases, and do not use abbreviations, such as number, rather than num. Here are some examples of variable naming.

Int number=0; string sqlString= "; double averageScore=0.0; CollegeStudent collegeStudent=new CollegeStudent (); at this point, I believe you have a deeper understanding of" what are the naming conventions of C# ". You might as well do it in practice. Here is the website, more related content can enter the relevant channels to inquire, follow us, continue to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.