C Sharp syntax
Find sources: "C Sharp syntax" – news · newspapers · books · scholar · JSTOR (January 2023) (Learn how and when to remove this message)
This article describes the syntax of the C# programming language. The features described are compatible with .NET Framework and Mono.
Basics
[edit ]Identifier
[edit ]An identifier is the name of a code element. It can contain letters, digits and underscores (_), and is case sensitive (FOO is different from foo). The language imposes the following restrictions on identifier names:
- They cannot start with a digit;
- They cannot start with a symbol, except for the at sign (
@), which can be used to prefix keywords to allow them as identifiers; - They cannot contain more than 511 characters.
Identifier names may be prefixed by @, which allows the use of reserved keywords as identifiers (for example, @class), but the @ is not considered part of the identifier's name for most purposes; @name and name refer to the same identifier unless name is a keyword.
Microsoft offered naming conventions for identifiers in C#, recommending the use of PascalCase for the names of types and most type members, and camelCase for variables and for private or internal fields.[1] These naming conventions are not enforced by the language.
Keywords
[edit ]Keywords
[edit ]Keywords are words with syntactic meaning.[2] The language has two types of keyword — contextual and reserved. Reserved keywords such as false or byte may only be used as keywords. Contextual keywords such as where or from are treated as keywords only in certain situations.[3] If an identifier is needed that matches a reserved keyword, it is prefixed by an @ sign to distinguish it. For example, @out is interpreted as an identifier, whereas out is a keyword. This syntax facilitates reuse of .NET code written in other languages.[4]
The following C# keywords are reserved words, of which there are 77.[2]
abstractasbaseboolbreakbytecasecatchcharcheckedclassconstcontinuedecimaldefaultdelegatedodoubleelseenumeventexplicitexternfalsefinallyfixedfloatforforeachgotoifimplicitinintinterfaceinternalislocklongnamespacenewnullobjectoperatoroutoverrideparamsprivateprotectedpublicreadonlyrefreturnsbytesealedshortsizeofstackallocstaticstringstructswitchthisthrowtruetrytypeofuintulonguncheckedunsafeushortusingvirtualvoidvolatilewhile
Contextual keywords
[edit ]A contextual keyword is used to provide a specific meaning in the code, but it is not a reserved word in C#. Some contextual keywords, such as partial and where, have meanings in multiple contexts. The following 42 C# keywords are contextual.[5]
addallowsaliasandascendingargsasyncawaitbydescendingdynamicequalsfromgetglobalgroupinitintojoinletmanagednameofnintnotnotnullnuintonororderbypartialrecordremoverequiredselectsetunmanagedvaluevarwhenwherewithyield
Preprocessor directives
[edit ]Although C# does not have a separate preprocessor, unlike C and C++ which use the C preprocessor, these 13 directives are processed as if there were one.
#nullable#if#elif#else#endif#define#undef#region#endregion#error#warning#line#pragma
Literals
[edit ]| decimal | 23456,[0..9]+
|
|---|---|
| hexadecimal | 0xF5,0x[0..9,A..F,a..f]+
|
| binary | 0b010110001101,0b[0,1]+
|
| float | 23.5F,23.5f;1.72E3F,1.72E3f,1.72e3F,1.72e3f
|
|---|---|
| double | 23.5,23.5D,23.5d;1.72E3,1.72E3D,...
|
| decimal | 79228162514264337593543950335m,-0.0000000000000000000000000001m,...
|
| char | 'a','Z','\u0231','\x30','\n'
|
|---|
| string | "Hello, world""C:\\Windows\\", @"C:\Windows\" [verbatim strings (preceded by @) may include line-break and carriage return characters]$"Hello, {name}!" Interpolated string. As a verbatim string: $@"Hello, {name}!"
|
|---|
| Unicode character | \u followed by the hexadecimal unicode code point
|
|---|---|
| Extended_ASCII character | \x followed by the hexadecimal extended ASCII code point
|
| Null character [a] | \0 Null character
|
| Tab | \t Tab
|
| Backspace | \b Backspace
|
| Carriage return | \r Carriage return (moves cursor to the start of the current line)
|
| Form feed | \f Form feed (page break)
|
| Backslash | \\ Backslash
|
| Single quote | \' Single quote
|
| Double quote | \" Double quote
|
| Line feed | \n Line feed (moves cursor to the next line)
|
- ^ Strings are not null-terminated in C#, so null characters may appear anywhere in a string.
Digit separators
[edit ]Starting in C# 7.0, the underscore symbol can be used to separate digits in number values for readability purposes. The compiler ignores these underscores.[6]
intbin=0b1101_0010_1011_0100; inthex=0x2F_BB_4A_F1; intdec=1_000_500_954; doublereal=1_500.200_2e-1_000;
Generally, separators may be put only between digit characters. It cannot be put at the beginning (_121) or the end of the value (121_ or 121.05_), next to the decimal in floating point values (10_.0), next to the exponent character (1.1e_1), or next to the type specifier (10_f).
Variables
[edit ]Variables are identifiers associated with values. They are declared by writing the variable's type and name, and are optionally initialized in the same statement.[10] [11]
Declare
intmyInt;// Declaring an uninitialized variable called 'myInt', of type 'int'
Assigning
intmyInt;// Declaring an uninitialized variable myInt=35;// Assigning the variable a value
Initialize
intmyInt=35;// Declaring and initializing the variable
Multiple variables of the same type can be declared and initialized in one statement.
inta,b;// Declaring multiple variables of the same type inta=2,b=3;// Declaring and initializing multiple variables of the same type
Local variable type inference
[edit ]- This is a feature of C# 3.0.
C# 3.0 introduced type inference, allowing the type specifier of a variable declaration to be replaced by the keyword var, if its actual type can be statically determined from the initializer. This reduces repetition, especially for types with multiple generic type-parameters, and adheres more closely to the DRY principle.
varmyChars=newchar[]{'A','Ö'}; // equivalent to: char[]myChars=newchar[]{'A','Ö'}; varmyNums=newList<int>(); // equivalent to: List<int>myNums=newList<int>();
Constants
[edit ]Constants are immutable values.
const
[edit ]When declaring a local variable or a field with the const keyword as a prefix the value must be given when it is declared. Thereafter the value cannot change. They can either be declared in the context as a field or a local variable.[10] Constants are implicitly static.
constdoublePI=3.14;
This shows both uses of the keyword.
publicclassFoo { privateconstdoubleX=3; publicFoo() { constinty=2; } }
readonly
[edit ]The readonly keyword does a similar thing to fields. Like fields marked as const their value cannot change once initialized. The difference is that one can choose to initialize them in a constructor, or to a value that is not known until run-time.[12] This works only on fields. readonly fields can either be members of an instance or static class members.
Code blocks
[edit ]Curly braces {...} are used to signify a code block and a new scope. Class members and the body of a method are examples of what can live inside these braces in various contexts.
Inside of method bodies, braces can be used to create new scopes:
voidDoSomething() { inta; { intb; a=1; } a=2; b=3;// Will fail because the variable is declared in an inner scope. }
Program structure
[edit ]A C# application consists of classes and their members. Classes and other types exist in namespaces and can be nested inside other classes.
Main method
[edit ]Every program must have an entry point. The entry point of a C# application is the Main method. There can only be one declaration of this method, and it is a static method in a class. It usually returns void and is passed command-line arguments as an array of strings.
staticvoidMain(string[]args)// string[] args can be omitted if the program doesn't have any command-line arguments. { }
The main method may return an integer value if specified.
staticintMain(string[]args) { return0; }
Async Main
[edit ]This is a feature of C# 7.1.
Asynchronous Tasks can be awaited in the Main method by declaring the method's return type as Task.
staticasyncTaskMain(string[]args) { awaitDoWorkAsync(42); }
All combinations of Task, or Task<int>, and with, or without, the string[] args parameter are supported.
Top-level statements
[edit ]This is a feature of C# 9.0.
Similar to in scripting languages, top-level statements remove the ceremony of having to declare the Program class with a Main method.
Instead, statements can be written directly in one file, which is the program entry point. Code in other files must be defined in classes.
This was introduced to make C# less verbose, and thus more accessible.
usingSystem; Console.WriteLine("Hello World!");
Types are declared after the statements, and are available from the statements above them.
Namespaces
[edit ]Namespaces are a part of a type name and are used to group and/or distinguish named entities from other ones.
System.IO.DirectoryInfo// DirectoryInfo is in the System.IO-namespace
A namespace is defined with the namespace keyword:
namespaceFooNamespace { // Members }
A namespace can be nested inside a namespace in three ways:
namespaceFooNamespace { // Members namespaceBarNamespace { // Members } }
and:
namespaceFooNamspace { // Members } namespaceFooNamspace.BarNamespace { // Members }
In C# 10 and later, namespaces can be defined using file-scoped declarations by doing the following:[13]
namespaceFooNamespace;// the brackets are omitted here in favor of a semicolon.
using directive
[edit ]The using directive loads a specific namespace from a referenced assembly. It is usually placed in the top (or header) of a code file but it can be placed elsewhere, e.g. inside a class.[citation needed ]
usingSystem; usingSystem.Collections;
The directive can also be used to define another name for an existing namespace or type. This is useful when names are long.
usingNet=System.Net; usingDirInfo=System.IO.DirectoryInfo;
usingstatic directive
[edit ]The usingstatic directive loads the static members of a specified type into the current scope, making them accessible directly by the name of the member.
usingstaticSystem.Console; WriteLine("Hello, World!");
globalusing directive
[edit ]Since C# 10, it is legal to write globalusing directives to indicate a using directive once and apply it to all source files.
globalusingSystem; globalusingMicrosoft.Extensions.FileSystemGlobbing;
Operators
[edit ]| Operator category | Operators |
|---|---|
| Arithmetic | +, -, *, /, %
|
| Logical (boolean and bitwise) | &, |, ^, !, ~, &&, ||, true, false
|
| String concatenation | +
|
| Increment, decrement | ++, --
|
| Shift | <<, >>
|
| Relational (conditional) | ==, !=, <, >, <=, >=
|
| Assignment | =, +=, -=, *=, /=, %=, &=, |=, ^=, <<=, >>=
|
| Member access | ., ?., ?[]
|
| Indexing | []
|
| Cast | ()
|
| Conditional (ternary) | ?:
|
| Delegate concatenation and removal | +, -
|
| Object creation | new
|
| Type information | as, is, sizeof, typeof
|
| Overflow exception control | checked, unchecked
|
| Indirection and Address | *, ->, [], &
|
| Coalesce | ??
|
| Lambda expression | =>
|
Operator overloading
[edit ]Some operators can be overloaded by writing an overload method.
publicstaticFoooperator+(Foofoo,Barbar) { returnnewFoo(foo.Value+bar.Value); }
These are the overloadable operators:
| Operators | |
|---|---|
+, -, !, ~, ++, --, true, false
|
Unary operators |
+, -, *, /, %, &, |, ^, <<, >>
|
Binary operators |
==, !=, <, >, <=, >=
|
Comparison operators, must be overloaded in pairs |
- Assignment operators (
+=,*=etc.) are combinations of a binary operator and the assignment operator (=) and is evaluated using the ordinary operators, which can be overloaded. - Cast operators (
()) cannot be overloaded, but it is possible to define conversion operators. - Array indexing (
[ ]) operator is not overloadable, but it is possible to define new indexers.
Conversion operators
[edit ]The cast operator is not overloadable, but a conversion operator method can live in the target class. Conversion methods can define two varieties of operators, implicit and explicit conversion operators. The implicit operator will cast without specifying with the cast operator (()) while the explicit operator requires it to be used.
Implicit conversion operator
[edit ]classFoo { publicintValue; publicstaticimplicitoperatorFoo(intvalue) { returnnewFoo(value); } } // Implicit conversion Foofoo=2;
Explicit conversion operator
[edit ]classFoo { publicintValue; publicstaticexplicitoperatorFoo(intvalue) { returnnewFoo(value); } } // Explicit conversion Foofoo=(Foo)2;
as operator
[edit ]The as operator will attempt to do a silent cast to a given type. It will return the object as the new type if possible, and otherwise will return null.
Streamstream=File.Open(@"C:\Temp\data.dat"); FileStreamfstream=streamasFileStream;// Will return an object. Stringstr=streamasString;// Will return null.
Null coalesce operator
[edit ]- This is a feature of C# 2.0.
The following:
returnifNotNullValue??otherwiseValue;
is shorthand for:
returnifNotNullValue!=null?ifNotNullValue:otherwiseValue;
Meaning that if the content of variable ifNotNullValue is not null, that content is returned, otherwise the content of variable otherwiseValue is returned.
C# 8.0 introduces null-coalescing assignment, such that
variable??=otherwiseValue;
is equivalent to
if(variableisnull)variable=otherwiseValue;
Control structures
[edit ]C# inherits most of the control structures of C/C++ and adds others such as the foreach statement.
Conditional structures
[edit ]These structures control the flow of the program through given conditions.
if statement
[edit ]The if statement is entered when the given condition is true. Single-line case statements do not require block braces although it is mostly preferred by convention.
A simple one-line statement:
if(i==3)...;
Multi-line with else-block (without any braces):
if(i==2) ... else ...
Recommended coding conventions for an if-statement.
if(i==3) { ... } elseif(i==2) { ... } else { ... }
switch statement
[edit ]The switch construct serves as a filter for different values. Each value leads to a "case". Falling through case sections is not allowed and therefore the keyword break is typically used to end a case. An unconditional return in a case section can also be used to end a case. goto statements can be used to fall through from one case to the next. The default case handles all cases not explicitly handled by the construct.
switch(ch) { case'A': statement; ... break; case'B': statement; break; case'C':// A switch section can have multiple case labels. case'D': ... break; default: ... break; }
Iteration structures
[edit ]Iteration statements are statements that repeatedly execute when a given condition evaluates as true.
while loop
[edit ]while(i==true) { ... }
do ... while loop
[edit ]do { } while(i==true);
for loop
[edit ]The for loop consists of three parts: declaration, condition and counter expression. All are optional.
for(inti=0;i<10;i++) { ... }
Is equivalent to this code represented with a while statement, except here the i variable is not local to the loop.
inti=0; while(i<10) { //... i++; }
foreach loop
[edit ]The foreach statement is derived from the for statement and makes use of a certain pattern described in C#'s language specification in order to obtain and use an enumerator of elements to iterate over.
Each item in the given collection is returned in the context of the code block. When the block has been executed the next item is returned until there are no items remaining.
foreach(intiinintList) { ... }
Jump statements
[edit ]Jump statements are inherited from C/C++ and ultimately assembly languages through it. They represent the jump-instructions of an assembly language that controls the flow of a program.
Labels and goto statement
[edit ]Labels are given points in code that can be jumped to by using the goto statement.
start: ....... gotostart;
Note that the label need not be positioned after the goto statement; it may be before it in the source file.
The goto statement can be used in switch statements to jump from one case to another or to fall through from one case to the next.
switch(n) { case1: Console.WriteLine("Case 1"); break; case2: Console.WriteLine("Case 2"); gotocase1; case3: Console.WriteLine("Case 3"); case4:// Compilation will fail here as cases cannot fall through in C#. Console.WriteLine("Case 4"); gotodefault;// This is the correct way to fall through to the next case. case5:// Multiple labels for the same code are OK case6: default: Console.WriteLine("Default"); break;// Even default must not reach the end point }
break statement
[edit ]The break statement breaks out of the closest loop or switch statement. Execution continues in the statement after the terminated statement, if any.
inte=10; for(inti=0;i<e;i++) { while(true) { break; } // Will break to this point. }
continue statement
[edit ]The continue statement discontinues the current iteration of the current control statement and begins the next iteration.
intch; while((ch=Console.Read())!=-1) { if(ch==' ') { continue;// Skips the rest of the while-loop } // Rest of the while-loop ... }
The while loop in the code above reads characters by calling GetChar(), skipping the statements in the body of the loop if the characters are spaces.
Exception handling
[edit ]Runtime exception handling method in C# is inherited from Java and C++.
The base class library has a class called System.Exception from which all other exception classes are derived. An Exception-object contains all the information about a specific exception and also the inner exceptions that were caused. Programmers may define their own exceptions by deriving from the Exception class.
An exception can be thrown this way:
thrownewNotImplementedException();
try...catch...finally statements
[edit ]Exceptions are managed within try...catch blocks.
try { // Statements which may throw exceptions ... } catch(Exceptionex) { // Exception caught and handled here ... } finally { // Statements always executed after the try/catch blocks ... }
The statements within the try block are executed, and if any of them throws an exception, execution of the block is discontinued and the exception is handled by the catch block. There may be multiple catch blocks, in which case the first block with an exception variable whose type matches the type of the thrown exception is executed.
If no catch block matches the type of the thrown exception, the execution of the outer block (or method) containing the try ... catch statement is discontinued, and the exception is passed up and outside the containing block or method. The exception is propagated upwards through the call stack until a matching catch block is found within one of the currently active methods. If the exception propagates all the way up to the top-most Main() method without a matching catch block being found, the entire program is terminated and a textual description of the exception is written to the standard output stream.
The statements within the finally block are always executed after the try and catch blocks, whether or not an exception was thrown.
Either a catch block, a finally block, or both, must follow the try block.
Types
[edit ]C# is a statically typed language like C and C++. That means that every variable and constant gets a fixed type when it is declared. The two kinds of types are value types and reference types.
Value types
[edit ]Instances of value types reside on the stack, i.e. they are bound to their variables. If one declares a variable for a value type the memory gets allocated directly. If the variable falls out of scope it is destroyed.
Structures
[edit ]Structures are more commonly known as structs. Structs are user-defined value types that are declared using the struct keyword. They are similar to classes but are more suitable for lightweight types. Some important syntactical differences between a class and a struct are presented later in this article.
structFoo { ... }
The primitive data types are all structs.
Pre-defined types
[edit ]| Primitive types | |||||
|---|---|---|---|---|---|
| Type name | BCL equivalent | Value | Range | Size | Default value |
sbyte
|
System.SByte
|
integer | −128 through +127 | 8-bit (1-byte) | 0
|
short
|
System.Int16
|
integer | −32,768 through +32,767 | 16-bit (2-byte) | 0
|
int
|
System.Int32
|
integer | −2,147,483,648 through +2,147,483,647 | 32-bit (4-byte) | 0
|
long
|
System.Int64
|
integer | −9,223,372,036,854,775,808 through +9,223,372,036,854,775,807 |
64-bit (8-byte) | 0
|
byte
|
System.Byte
|
unsigned integer | 0 through 255 | 8-bit (1-byte) | 0
|
ushort
|
System.UInt16
|
unsigned integer | 0 through 65,535 | 16-bit (2-byte) | 0
|
uint
|
System.UInt32
|
unsigned integer | 0 through 4,294,967,295 | 32-bit (4-byte) | 0
|
ulong
|
System.UInt64
|
unsigned integer | 0 through 18,446,744,073,709,551,615 | 64-bit (8-byte) | 0
|
decimal
|
System.Decimal
|
signed decimal number | −79,228,162,514,264,337,593,543,950,335 through +79,228,162,514,264,337,593,543,950,335 |
128-bit (16-byte) | 0.0
|
float
|
System.Single
|
floating point number | ±1.401298E−45 through ±3.402823E+38 | 32-bit (4-byte) | 0.0
|
double
|
System.Double
|
floating point number | ±4.94065645841246E−324 through ±1.79769313486232E+308 |
64-bit (8-byte) | 0.0
|
bool
|
System.Boolean
|
Boolean | true or false
|
8-bit (1-byte) | false
|
char
|
System.Char
|
single Unicode character | '\u0000' through '\uFFFF'
|
16-bit (2-byte) | '\u0000'
|
Note: string (System.String) is not a struct and is not a primitive type.
Enumerations
[edit ]Enumerated types (declared with enum) are named values representing integer values.
enumSeason { Winter=0, Spring=1, Summer=2, Autumn=3, Fall=Autumn// Autumn is called Fall in American English. }
Enum variables are initialized by default to zero. They can be assigned or initialized to the named values defined by the enumeration type.
Seasonseason; season=Season.Spring;
Enum type variables are integer values. Addition and subtraction between variables of the same type is allowed without any specific cast but multiplication and division is somewhat more risky and requires an explicit cast. Casts are also required for converting enum variables to and from integer types. However, the cast does not throw an exception if the value is not specified by the type definition.
season=(Season)2;// cast 2 to an enum-value of type Season. season=season+1;// Adds 1 to the value. season=season+season2;// Adding the values of two enum variables. intvalue=(int)season;// Casting enum-value to integer value. season++;// Season.Spring (1) becomes Season.Summer (2). season--;// Season.Summer (2) becomes Season.Spring (1).
Values can be combined using the bitwise-OR operator |.
ColormyColors=Color.Green|Color.Yellow|Color.Blue;
Reference types
[edit ]Variables created for reference types are typed managed references. When the constructor is called, an object is created on the heap and a reference is assigned to the variable. When a variable of an object goes out of scope the reference is broken and when no references are left the object gets marked as garbage. The garbage collector then collects and destroys it.
A reference variable is null when it does not reference any object.
Arrays
[edit ]An array type is a reference type that refers to a space containing one or more elements of a certain type. All array types derive from a common base class, System.Array. Each element is referenced by its index as in C++ and Java.
An array in C# is what is called a dynamic array in C++.
int[]numbers=newint[2]; numbers[0]=2; numbers[1]=5; intx=numbers[0];
Initializers
[edit ]Array initializers provide convenient syntax for initialization of arrays.
// Long syntax int[]numbers=newint[5]{20,1,42,15,34}; // Short syntax int[]numbers2={20,1,42,15,34}; // Inferred syntax varnumbers3=new[]{20,1,42,15,34};
Multi-dimensional arrays
[edit ]Arrays can have more than one dimension, for example 2 dimensions to represent a grid.
int[,]numbers=newint[3,3]; numbers[1,2]=2; int[,]numbers2=newint[3,3]{{2,3,2},{1,2,6},{2,4,5}};
See also
Classes
[edit ]Classes are self-describing user-defined reference types. Essentially all types in the .NET Framework are classes, including structs and enums, that are compiler generated classes. Class members are private by default, but can be declared as public to be visible outside of the class or protected to be visible by any descendants of the class.
Strings
[edit ]The System.String class, or string, represents an immutable sequence of unicode characters (char).
Actions performed on a string always return a new string.
stringtext="Hello World!"; stringsubstr=text.Substring(0,5); string[]parts=text.Split(newchar[]{' '});
The System.StringBuilder class can be used when a mutable "string" is wanted.
StringBuildersb=newStringBuilder(); sb.Append('H'); sb.Append("el"); sb.AppendLine("lo!");
Interface
[edit ]Interfaces are data structures that contain member definitions without implementations. A variable of an interface type is a reference to an instance of a class which implements this interface. See #Interfaces.
Delegates
[edit ]C# provides type-safe object-oriented function pointers in the form of delegates.
classProgram { // Delegate type: delegateintOperation(inta,intb); staticintAdd(inti1,inti2) { returni1+i2; } staticintSub(inti1,inti2) { returni1-i2; } staticvoidMain() { // Instantiate the delegate and assign the method to it. Operationop=Add; // Call the method that the delegate points to. intresult1=op(2,3);// 5 op=Sub; intresult2=op(10,2);// 8 } }
Initializing the delegate with an anonymous method.
addition=delegate(inta,intb){returna+b;};
Initializing the delegate with lambda expression.
addition=(a,b)=>a+b;
Events
[edit ]Events are pointers that can point to multiple methods. More exactly they bind method pointers to one identifier. This can therefore be seen as an extension to delegates. They are typically used as triggers in UI development. The form used in C# and the rest of the Common Language Infrastructure is based on classic Visual Basic.
usingSystem.Windows.Controls; delegatevoidMouseEventHandler(objectsender,MouseEventArgse); publicclassButton:Control { privateeventMouseEventHandler_onClick; /* Imaginary trigger function */ voidClick() { _onClick(this,newMouseEventArgs(data)); } }
An event requires an accompanied event handler that is made from a special delegate that in a platform specific library such as Windows Presentation Foundation and Windows Forms usually takes two parameters: sender and event arguments. The type of the event argument-object derive from the EventArgs class that is a part of the CLI base library.
Once declared in its class the only way of invoking the event is from inside of the owner. A listener method may be implemented outside to be triggered when the event is fired.
publicclassMainWindow:System.Windows.Controls.Window { privateButton_button1; publicMainWindow() { _button1=newButton(); _button1.Text="Click me!"; /* Subscribe to the event */ _button1.ClickEvent+=Button1_OnClick; /* Alternate syntax that is considered old: _button1.MouseClick += new MouseEventHandler(Button1_OnClick); */ } protectedvoidButton1_OnClick(objectsender,MouseEventArgse) { MessageBox.Show("Clicked!"); } }
Custom event implementation is also possible:
privateEventHandler_clickHandles=(s,e)=>{}; publiceventEventHandlerClick { add { // Some code to run when handler is added... ... _clickHandles+=value; } remove { // Some code to run when handler is removed... ... _clickHandles-=value; } }
See also
Nullable types
[edit ]- This is a feature of C# 2.0.
Nullable types were introduced in C# 2.0 firstly to enable value types to be null (useful when working with a database).
int?n=2; n=null; Console.WriteLine(n.HasValue);
This is the same as using the Nullable<T> struct.
Nullable<int>n=2; n=null; Console.WriteLine(n.HasValue);
Pointers
[edit ]C# has and allows pointers to selected types (some primitives, enums, strings, pointers, and even arrays and structs if they contain only types that can be pointed[14] ) in unsafe context: methods and codeblock marked unsafe. These are syntactically the same as pointers in C and C++. However, runtime-checking is disabled inside unsafe blocks.
staticvoidMain(string[]args) { unsafe { inta=2; int*b=&a; Console.WriteLine("Address of a: {0}. Value: {1}",(int)&a,a); Console.WriteLine("Address of b: {0}. Value: {1}. Value of *b: {2}",(int)&b,(int)b,*b); // Will output something like: // Address of a: 71953600. Value: 2 // Address of b: 71953596. Value: 71953600. Value of *b: 2 } }
Structs are required only to be pure structs with no members of a managed reference type, e.g. a string or any other class.
publicstructMyStruct { publiccharCharacter; publicintInteger; } publicstructMyContainerStruct { publicbyteByte; publicMyStructMyStruct; }
In use:
MyContainerStructx; MyContainerStruct*ptr=&x; bytevalue=ptr->Byte;
Dynamic
[edit ]- This is a feature of C# 4.0 and .NET Framework 4.0.
Type dynamic enables dynamic runtime lookup to C# in a static manner. Dynamic denotes a variable with an object with a type that is resolved at runtime, as opposed to compile-time.
This feature takes advantage of the Dynamic Language Runtime (DLR) and is designed with the goal of interoperation with dynamically typed languages like IronPython and IronRuby (Implementations of Python and Ruby for .NET).
Dynamic-support also eases interoperation with COM objects.
dynamicx=newFoo(); x.DoSomething();// Will compile and resolved at runtime. An exception will be thrown if invalid.
Anonymous types
[edit ]- This is a feature of C# 3.0.
Anonymous types are nameless classes that are generated by the compiler. They are only consumable and yet useful in a scenario such as a LINQ query that returns an object on select to return some specific values. Then, define an anonymous type containing auto-generated read-only fields for the values.
When instantiating another anonymous type declaration with the same signature the type is automatically inferred by the compiler.
varcarl=new{Name="Carl",Age=35};// Name of the type is only known by the compiler. varmary=new{Name="Mary",Age=22};// Same type as the expression above
Boxing and unboxing
[edit ]Boxing is the operation of converting a value of a value type into a value of a corresponding reference type.[15] Boxing in C# is implicit.
Unboxing is the operation of converting a value of a reference type (previously boxed) into a value of a value type.[15] Unboxing in C# requires an explicit type cast.
Example:
intfoo=42;// Value type. objectbar=foo;// foo is boxed to bar. intfoo2=(int)bar;// Unboxed back to value type.
Object-oriented programming
[edit ]C# has direct support for object-oriented programming.
Objects
[edit ]An object is created with the type as a template and is called an instance of that particular type.
In C#, objects are either references or values. No syntactical distinction is made between those in code.
Object class
[edit ]All types, even value types in their boxed form, implicitly inherit from the System.Object class, the base class. This class contains the most common methods shared by all objects. Some of these are virtual and can be overridden.
Classes inherit System.Object either directly or indirectly through another base class.
Members
Some members of the Object class:
Equals- Supports comparisons between objects.Finalize- Performs cleanup operations before an object is automatically reclaimed. (Default destructor)GetHashCode- Gets the number corresponding to the value of the object to support the use of a hash table.GetType- Gets the Type of the current instance.ToString- Creates a human-readable text string that describes an instance of the class. Usually returns the type name.
Classes
[edit ]Classes are fundamentals of an object-oriented language such as C#. They serve as a template for objects. They contain members that store and manipulate data in a real-life like way.
Differences between classes and structs
[edit ]Although classes and structures are similar in both the way they are declared and how they are used, some significant differences apply. Classes are reference types and structs are value types. A structure is allocated on the stack when it is declared and the variable is bound to its address. It directly contains the value. Classes are different because the memory is allocated on the heap. Variables are references, managed pointers on the stack which point to the objects.
Structures differ from classes in other ways. For example, while both offer an implicit default constructor that takes no arguments, it cannot be redefined for structs. Explicitly defining a differently-parametrized constructor overrides the implicit default constructor in classes, but not in structs. All fields of a struct must be initialized in those constructors. Structs do not have finalizers and cannot inherit from another class like classes do. Implicitly, they are sealed and inherit from System.ValueType (which inherits from System.Object). Structs are more suitable for smaller amounts of data.
| Default constructor | Finalizer | Member initialization | Inheritance | |
|---|---|---|---|---|
| Classes | not required (auto generated)[a] | yes | not required | yes (if base class is not sealed)
|
| Structs | required (auto generated)[b] | no | required | not supported |
Declaration
[edit ]Class declaration:
classFoo { // Member declarations }
Partial class
[edit ]- This is a feature of C# 2.0.
A partial class is a class declaration whose code is divided into separate files. The different parts of a partial class must be marked with keyword partial.
// File1.cs partialclassFoo { ... } // File2.cs partialclassFoo { ... }
The usual reason for using partial classes is to split some class into programmer-maintained and tool-maintained parts, i.e. some code is automatically generated by a user-interface designing tool or something alike.
Initialization
[edit ]Before one can use the members of the class, initialize the variable with a reference to an object. To create it, call the appropriate constructor using the new keyword. It has the same name as the class.
Foofoo=newFoo(); StreamReadersr=newStreamReader("MyFile.txt");
For structs it is optional to explicitly call a constructor because the default one is called automatically. It must be declared and it gets initialized with standard values.
To reduce boilerplate, if the type is given in a declaration (i.e. not using var), the constructor can be invoked with just new().
Foofoo=new(); StreamReadersr=new("MyFile.txt");
Object initializers
[edit ]- This is a feature of C# 3.0.
Provides a more convenient way of initializing public fields and properties of an object. Constructor calls are optional given a default constructor.
Personperson=newPerson { Name="John Doe", Age=39 }; // Equal to Personperson=newPerson(); person.Name="John Doe"; person.Age=39;
Collection initializers
[edit ]- This is a feature of C# 3.0.
Collection initializers give an array-like syntax for initializing collections. The compiler generates calls to the Add-method. This works for classes that implement the interface ICollection.
List<int>list=newList<int>{2,5,6,6}; // Equal to List<int>list=newList<int>(); list.Add(2); list.Add(5); list.Add(6); list.Add(6);
Accessing members
[edit ]Members of an instance and static members of a class are accessed using the . operator.
Accessing an instance member
Instance members can be accessed through the name of a variable.
stringfoo="Hello"; stringfooUpper=foo.ToUpper();
Accessing a static class member
Static members are accessed by using the name of the class or other type.
intr=String.Compare(foo,fooUpper);
Accessing a member through a pointer
In unsafe code, members of a value (struct type) referenced by a pointer are accessed with the -> operator as in C and C++.
POINTp; p.X=2; p.Y=6; POINT*ptr=&p; ptr->Y=4;
Modifiers
[edit ]Modifiers are keywords used to modify declarations of types and type members. Most notable is a sub-group containing the access modifiers.
Class modifiers
[edit ]abstract- Specifies that a class serves only as a base class. It implemented in an inheriting class. Required for classes to have abstract methods.sealed- Specifies that a class cannot be inherited.
Class member modifiers
[edit ]abstract- Declares a method to be available in all derived non-abstract classes.const- Specifies that a variable is a constant value that has to be initialized when it gets declared.event- Declares an event.extern- Specifies that a method signature without a body uses a DLL-import.override- Specifies that a method or property declaration is an override of a virtual member or an implementation of a member of an abstract class.readonly- Declares a field that can only be assigned values as part of the declaration or in a constructor in the same class.unsafe- Specifies an unsafe context, which allows the use of pointers.virtual- Specifies that a method or property declaration can be overridden by a derived class.volatile- Specifies a field that can be modified by an external process and prevents an optimizing compiler from making guesses about the persistence of the current value of the field.
static modifier
[edit ]The static modifier states that a member belongs to the class and not to a specific object. Classes marked static are only allowed to contain static members. Static members are sometimes referred to as class members since they apply to the class as a whole and not to its instances.
publicclassFoo { publicstaticvoidSomething() { ... } } // Calling the class method. Foo.Something();
Access modifiers
[edit ]Access modifiers, or inheritance modifiers, set the accessibility of classes, methods, and other members. Items marked public can be reached from anywhere. private members can only be accessed from the class they are declared in and hidden when inherited. Members with the protected modifier are private, but accessible when inherited. internal classes and members are only accessible from inside of the declaring assembly.
Classes and structs are implicitly internal and members are implicitly private if they do not have an access modifier.
publicclassFoo { publicintDo() { return0; } publicclassBar { } }
| Unnested types | Members (incl. nested types) | Accessible to | |
|---|---|---|---|
public
|
yes | yes | all |
protected internal
|
no | yes | same class, derived classes, and everything in the same assembly |
protected
|
no | yes | same class and derived classes |
internal
|
yes (default) | yes | everything in the same assembly |
private protected
|
no | yes | same class, and derived classes in the same assembly |
private
|
no | yes (default) | same class |
Constructors
[edit ]A constructor is a special method that is called when an object is created. Its purpose is to initialize the members of the object. Constructors have the same name as the class and do not return any value. Implicitly, they return the newly created object when called via the new operator. They may take parameters like any other method. The parameter-less constructor is special because it can be specified as a necessary constraint for a generic type parameter.
classFoo { Foo() { ... } }
Constructors can be public, private, protected or internal.
Destructor
[edit ]The destructor is called when the object is collected by the garbage collector to perform manual clean-up. The default destructor method called finalize can be overridden.
The syntax is similar to that of constructors. The difference is that the name is preceded by a ~ and it cannot include parameters. Only one destructor can be declared.
classFoo { ... ~Foo() { ... } }
Finalizers are always private.
Methods
[edit ]As in C and C++ functions group reusable code. The main difference is that functions, as in Java, have to reside inside of a class. A function is therefore called a method. A method has a return value, a name and usually parameters initialized when it is called with arguments. It can belong either to an instance of a class or be static.
classFoo { intBar(inta,intb) { returna%b; } }
A method is called using . notation on a specific variable, or as in the case of static methods, the name of a type.
Foofoo=newFoo(); intr=foo.Bar(7,2); Console.WriteLine(r);
ref and out parameters
[edit ]Arguments pass by reference when calling a method with parameters preceded by keywords ref or out. These managed pointers come in handy when passing variables to be modified inside the method. The main difference between the two is that an out parameter must have been assigned within the method by the time the method returns. ref may or may not assign a new value, but the parameter variable has to be initialized before calling the function.
voidPassRef(refintx) { if(x==2) { x=10; } } intZ=7; PassRef(refZ); voidPassOut(outintx) { x=2; } intQ; PassOut(outQ);
Optional parameters
[edit ]- This is a feature of C# 4.0.
C# 4.0 introduces optional parameters with default values as seen in C++. For example:
voidIncrement(refintx,intdx=1) { x+=dx; } intx=0; Increment(refx);// dx takes the default value of 1 Increment(refx,2);// dx takes the value 2
In addition, to complement optional parameters, it is possible to explicitly specify parameter names in method calls, to selectively pass a subset of optional parameters for a method. The only restriction is that named parameters must be placed after unnamed parameters. Parameter names can be specified for both optional and required parameters, and can be used to improve readability or arbitrarily reorder arguments in a call. For example:
StreamOpenFile(stringname,FileModemode=FileMode.Open, FileAccessaccess=FileAccess.Read){...} OpenFile("file.txt");// use default values for both "mode" and "access" OpenFile("file.txt",mode:FileMode.Create);// use default value for "access" OpenFile("file.txt",access:FileAccess.Read);// use default value for "mode" OpenFile(name:"file.txt",access:FileAccess.Read,mode:FileMode.Create); // name all parameters for extra readability, // and use order different from method declaration
Optional parameters make interoperating with COM easier. Previously, C# had to pass in every parameter in the method of the COM component, even those that are optional. For example:
objectfileName="Test.docx"; objectmissing=System.Reflection.Missing.Value; doc.SaveAs(reffileName, refmissing,refmissing,refmissing, refmissing,refmissing,refmissing, refmissing,refmissing,refmissing, refmissing,refmissing,refmissing, refmissing,refmissing,refmissing); console.writeline("File saved successfully");
With support for optional parameters, the code can be shortened as
doc.SaveAs(reffileName);
extern
[edit ]C# can call native code. A method signature is declared without a body and is marked as extern. The DllImport attribute references the desired DLL.
[DllImport("win32.dll")] staticexterndoublePow(doublea,doubleb);
Fields
[edit ]Fields, or instance variables, can be declared inside the class body to store data.
classFoo { doublefoo; }
Fields can be initialized directly when declared (unless declared in struct).
classFoo { doublefoo=2.3; }
Modifiers for fields:
const- Makes the field a constant.private- Makes the field private (default).protected- Makes the field protected.public- Makes the field public.readonly- Allows the field to be initialized only once in a constructor.static- Makes the field a static member, i.e. a class variable.
Properties
[edit ]Properties bring field-like syntax and combine them with methods. A property can have two accessors: get and set.
publicclassPerson { privatestring_name; stringName { get{return_name;} set{_name=value;} } } // Using a property varperson=newPerson(); person.Name="Robert";
Modifiers for properties:
private- Makes the property private (default).protected- Makes the property protected.public- Makes the property public.static- Makes the property a static member.
Modifiers for property accessors:
private- Makes the accessor private.protected- Makes the accessor protected.public- Makes the accessor public.
The default modifiers for the accessors are inherited from the property. Note that the accessor's modifiers can only be equal or more restrictive than the property's modifier.
Automatic properties
[edit ]- This is a feature of C# 3.0.
Auto-implemented properties use accessors without bodies so that the compiler generatea a backing field and the necessary code.
publicdoubleWidth{get;privateset;}
Indexers
[edit ]Indexers add array-like indexing capabilities to objects. They are implemented in a way similar to properties.
internalclassIntList { privateint[]_items; intthis[intindex] { get{return_items[index];} set{_items[index]=value;} } } // Using an indexer IntListlist=newIntList(); list[2]=2;
Inheritance
[edit ]Classes in C# may only inherit from one class. A class may derive from any class that is not marked as sealed.
classA { } classB:A { }
virtual
[edit ]Methods marked virtual provide an implementation that can be overridden by inheritors by using the override keyword.
The implementation is chosen by the type of the object and not the type of the variable.
classOperation { publicvirtualintDo() { return0; } } classNewOperation:Operation { publicoverrideintDo() { return1; } }
new
[edit ]When overloading a non-virtual method with another signature, the keyword new may be used. The method used is chosen by the variable type instead of the object type.
classOperation { publicintDo() { return0; } } classNewOperation:Operation { publicnewdoubleDo() { return4.0; } }
This demonstrates the case:
NewOperationop=newNewOperation(); // Will call "double Do()" in NewOperation doubled=op.Do(); Operationop_=op; // Will call "int Do()" in Operation inti=op_.Do();
abstract
[edit ]Abstract classes are classes that serve as templates and cannot be initialized. Otherwise, it is just like an ordinary class.
Abstract members are members of abstract classes that have no implementation. They must be overridden by non-abstract classes that inherit the member.
abstractclassMammal { publicabstractvoidWalk(); } classHuman:Mammal { publicoverridevoidWalk() { } ... }
sealed
[edit ]The sealed modifier can be combined with the others to make them uninheritable, or for methods to disallow overriding them in derived classes.
internalsealedclassFoo { //... } publicclassBar { publicvirtualvoidAction() { //... } } publicclassBaz:Bar { publicsealedoverridevoidAction() { //... } }
Interfaces
[edit ]Interfaces are data structures that contain member definitions, but not implementationa. They are used to define a contract between members in different types that have different implementations. Definitions can be supplied for methods, properties, and indexers. Interface members are implicitly public. An interface can either be implicitly or explicitly implemented.
interfaceIBinaryOperation { doubleA{get;set;} doubleB{get;set;} doubleGetResult(); }
Implementing an interface
[edit ]An interface is implemented by a class or extended by another interface in the same way a class is derived from another class using the : notation.
Implicit implementation
When implicitly implementing an interface the members of the interface have to be public.
publicclassAdder:IBinaryOperation { publicdoubleA{get;set;} publicdoubleB{get;set;} publicdoubleGetResult() { returnA+B; } } publicclassMultiplier:IBinaryOperation { publicdoubleA{get;set;} publicdoubleB{get;set;} publicdoubleGetResult() { returnA*B; } }
In use:
IBinaryOperationop=null; doubleresult; // Adder implements the interface IBinaryOperation. op=newAdder(); op.A=2; op.B=3; result=op.GetResult();// 5 // Multiplier also implements the interface. op=newMultiplier(); op.A=5; op.B=4; result=op.GetResult();// 20
Explicit implementation
Explicitly implemented members are accessible only when the object is handled as the interface type.
publicclassAdder:IBinaryOperation { doubleIBinaryOperation.A{get;set;} doubleIBinaryOperation.B{get;set;} doubleIBinaryOperation.GetResult() { return((IBinaryOperation)this).A+((IBinaryOperation)this).B; } }
In use:
Adderadd=newAdder(); // These members are not accessible: // add.A = 2; // add.B = 3; // double result = add.GetResult(); // Cast to the interface type to access them: IBinaryOperationadd2=add; add2.A=2; add2.B=3; doubleresult=add2.GetResult();
Properties in the class that extends IBinaryOperation are auto-implemented by the compiler and a backing field is automatically added (see #Automatic properties).
Extending multiple interfaces
Interfaces and classes are allowed to extend multiple interfaces.
classMyClass:IInterfaceA,IInterfaceB { ... }
An interface that extends two interfaces.
interfaceIInterfaceC:IInterfaceA,IInterfaceB { ... }
Interfaces vs. abstract classes
[edit ]Interfaces and abstract classes are similar. The following describes some important differences:
- An abstract class may have member variables as well as non-abstract methods or properties. An interface cannot.
- A class or abstract class can only inherit from one class or abstract class.
- A class or abstract class may implement one or more interfaces.
- An interface can extend only other interfaces.
- An abstract class may have non-public methods and properties (also abstract ones). An interface can have only public members.
- An abstract class may have constants, static methods and static members. An interface cannot.
- An abstract class may have constructors. An interface cannot.
Generics
[edit ]- This is a feature of C# 2.0 and .NET Framework 2.0.
Generics (or parameterized types, parametric polymorphism) use type parameters, which make it possible to design classes and methods that do not specify the type used until the class or method is instantiated. The main advantage is that one can use generic type parameters to create classes and methods that can be used without incurring the cost of runtime casts or boxing operations, as:[16]
// Declare the generic class. publicclassGenericList<T> { voidAdd(Tinput){} } classTestGenericList { privateclassExampleClass{} staticvoidMain() { // Declare a list of type int. GenericList<int>list1=newGenericList<int>(); // Declare a list of type string. GenericList<string>list2=newGenericList<string>(); // Declare a list of type ExampleClass. GenericList<ExampleClass>list3=newGenericList<ExampleClass>(); } }
When compared with C++ templates, C# generics can provide enhanced safety, but also have somewhat limited capabilities.[17] For example, it is not possible to call arithmetic operators on a C# generic type.[18] Unlike C++ templates, .NET parameterized types are instantiated at runtime rather than by the compiler; hence they can be cross-language whereas C++ templates cannot. They support some features not supported directly by C++ templates such as type constraints on generic parameters by use of interfaces. On the other hand, C# does not support non-type generic parameters.
Unlike generics in Java, .NET generics use reification to make parameterized types first-class objects in the Common Language Infrastructure (CLI) Virtual Machine, which allows for optimizations and preservation of the type information.[19]
Using generics
[edit ]Generic classes
[edit ]Classes and structs can be generic.
publicclassList<T> { ... publicvoidAdd(Titem) { ... } } varlist=newList<int>(); list.Add(6); list.Add(2);
Generic interfaces
[edit ]interfaceIEnumerable<T> { ... }
Generic delegates
[edit ]delegateRFunc<T1,T2,R>(T1a1,T2a2);
Generic methods
[edit ]publicstaticT[]CombineArrays<T>(T[]a,T[]b) { T[]newArray=newT[a.Length+b.Length]; a.CopyTo(newArray,0); b.CopyTo(newArray,a.Length); returnnewArray; } string[]a=newstring[]{"a","b","c"}; string[]b=newstring[]{"1","2","3"}; string[]c=CombineArrays(a,b); double[]da=newdouble[]{1.2,2.17,3.141592}; double[]db=newdouble[]{4.44,5.6,6.02}; double[]dc=CombineArrays(da,db); // c is a string array containing { "a", "b", "c", "1", "2", "3"} // dc is a double array containing { 1.2, 2.17, 3.141592, 4.44, 5.6, 6.02}
Type-parameters
[edit ]Type-parameters are names used in place of concrete types when defining a new generic. They may be associated with classes or methods by placing the type parameter in angle brackets <>. When instantiating (or calling) a generic, one can then substitute a concrete type for the type-parameter one gave in its declaration. Type parameters may be constrained by use of the where keyword and a constraint specification, any of the six comma separated constraints may be used:[20]
| Constraint | Explanation |
|---|---|
whereT:struct
|
type parameter must be a value type |
whereT:class
|
type parameter must be a reference type |
whereT:new()
|
type parameter must have a constructor with no parameters (must appear last) |
whereT:<base_class>
|
type parameter must inherit from <base_class>
|
whereT:<interface>
|
type parameter must be, or must implement this interface |
whereT:U
|
naked type parameter constraint |
Covariance and contravariance
[edit ]- This is a feature of C# 4.0 and .NET Framework 4.0.
Generic interfaces and delegates can have their type parameters marked as covariant or contravariant, using keywords out and in, respectively. These declarations are then respected for type conversions, both implicit and explicit, and both compile-time and run-time. For example, the existing interface IEnumerable<T> has been redefined as follows:
interfaceIEnumerable<outT> { IEnumerator<T>GetEnumerator(); }
Therefore, any class that implements IEnumerable<Derived> for some class Derived is also considered to be compatible with IEnumerable<Base> for all classes and interfaces Base that Derived extends, directly, or indirectly. In practice, it makes it possible to write code such as:
voidPrintAll(IEnumerable<object>objects) { foreach(objectoinobjects) { System.Console.WriteLine(o); } } IEnumerable<string>strings=newList<string>(); PrintAll(strings);// IEnumerable<string> is implicitly converted to IEnumerable<object>
For contravariance, the existing interface IComparer<T> has been redefined as:
publicinterfaceIComparer<inT> { intCompare(Tx,Ty); }
Therefore, any class that implements IComparer<Base> for some class Base is also considered to be compatible with IComparer<Derived> for all classes and interfaces Derived that are extended from Base. It makes it possible to write code such as:
IComparer<object>objectComparer=GetComparer(); IComparer<string>stringComparer=objectComparer;
Enumerators
[edit ]An enumerator is an iterator. Enumerators are typically obtained by calling the GetEnumerator() method of an object implementing the IEnumerable interface. Container classes typically implement this interface. However, the foreach statement in C# can operate on any object providing such a method, even if it doesn't implement IEnumerable. This interface was expanded into generic version in .NET 2.0.
The following shows a simple use of iterators in C# 2.0:
// explicit version IEnumerator<MyType>iter=list.GetEnumerator(); while(iter.MoveNext()) { Console.WriteLine(iter.Current); } // implicit version foreach(MyTypevalueinlist) { Console.WriteLine(value); }
Generator functionality
[edit ]- This is a feature of C# 2.0.
The .NET 2.0 Framework allowed C# to introduce an iterator that provides generator functionality, using a yieldreturn construct similar to yield in Python.[21] With a yieldreturn, the function automatically keeps its state during the iteration.
// Method that takes an iterable input (possibly an array) // and returns all even numbers. publicstaticIEnumerable<int>GetEven(IEnumerable<int>numbers) { foreach(intiinnumbers) { if(i%2==0) { yieldreturni; } } } // using the method to output only even numbers from the array staticvoidMain() { int[]numbers={1,2,3,4,5,6}; foreach(intiinGetEven(numbers)) { Console.WriteLine(i);// outputs 2, 4 and 6 } }
LINQ
[edit ]- This is a feature of C# 3.0 and .NET Framework 3.0.
LINQ, short for Language Integrated Queries, is a .NET Framework feature which simplifies the handling of data. Mainly it supports querying of arrays, collections, and databases. It introduces binders, which makes it easier to access to databases and their data.
Query syntax
[edit ]LINQ query syntax was introduced in C# 3.0 and supports SQL-like queries.
List<int>list=newList<int>{2,7,1,3,9}; IEnumerable<int>result=fromiinlist wherei>1 selecti; // Equivalent to: IEnumerable<int>result=list.Where(i=>i>1) .Select(i=>i)
The statements are compiled into method calls, whereby almost only the names of the methods are specified. Which methods are ultimately used is determined by normal overload resolution. Thus, the result of the translation is affected by the symbols in scope.
What differs from SQL is that the from-statement comes first and not last as in SQL. This seems more natural writing in C# [citation needed ] and supports "Intellisense" (Code completion in the editor).
Anonymous methods
[edit ]Anonymous methods, (lambda expressions), is a feature that allows programmers to write inline closure-like functions.
C# supports various ways to create anonymous methods.
Anonymous delegates
[edit ]- This is a feature of C# 2.0.
Anonymous delegates are function pointers that hold anonymous methods. The purpose is to make it simpler to use delegates by simplifying function assignment. Instead of declaring a separate method in code the programmer can use the syntax to write the code inline and the compiler generates an anonymous function for it.
Func<int,int>f=delegate(intx){returnx*2;};
Lambda expressions
[edit ]- This is a feature of C# 3.0.
Lambda expressions provide a simple syntax for inline functions that are similar to closures. Functions with parameters infer the type of the parameters if other is not explicitly specified.
// [arguments] => [method-body] // With parameters n=>n==2 (a,b)=>a+b (a,b)=>{a++;returna+b;} // With explicitly typed parameters (inta,intb)=>a+b // No parameters ()=>return0 // Assigning lambda to delegate Func<int,int,int>f=(a,b)=>a+b;
Multi-statement lambdas have bodies enclosed by braces and inside of them code can be written as in standard methods.
(a,b)=>{a++;returna+b;}
Lambda expressions can be passed as arguments directly in method calls similar to anonymous delegates but with a cleaner syntax.
varlist=stringList.Where(n=>n.Length>2);
Lambda expressions are compiler-generated methods passed via delegates. These methods are reserved for the compiler and cannot be used in any other context.
Extension methods
[edit ]- This is a feature of C# 3.0.
Extension methods are syntactic sugar providing the illusion of adding new methods to an existing class outside its definition. In practice, an extension method is a static method that is callable as if it were an instance method; the receiver of the call is bound to the first parameter of the method, decorated with keyword this:
publicstaticclassStringExtensions { publicstaticstringLeft(thisstrings,intn) { returns.Substring(0,n); } } strings="foo"; s.Left(3);// same as StringExtensions.Left(s, 3);
Local functions
[edit ]- This is a feature of C# 7.0.
Local functions can be defined in the body of another method, constructor or property's getter and setter. Such functions have access to all variables in the enclosing scope, including parent method local variables. They are in scope for the entire method, regardless of whether they are invoked before or after their declaration. Access modifiers (public, private, protected) cannot be used with local functions. They do not support function overloading, which means two local functions in the same method cannot have the same name even if the signatures don't overlap.[22] After a compilation, a local function is transformed into a private static method, but when defined it cannot be marked static.[23]
In the example below, the Sum method is a local function inside Main method. So it can be used only inside its parent method Main:
staticvoidMain(string[]args) { intSum(intx,inty) { returnx+y; } Console.WriteLine(Sum(10,20)); Console.ReadKey(); }
Miscellaneous
[edit ]Closure blocks
[edit ]C# implements closure blocks by means of the using statement. The using statement accepts an expression which results in an object implementing IDisposable, and the compiler generates code that guarantees the object's disposal when exiting the scope of the using-statement. The using statement is syntactic sugar. It makes the code more readable than the equivalent try...finally block.
publicvoidFoo() { using(FileStreambar=File.Open("Foo.txt")) { // do some work thrownewException(); // bar will still get properly disposed. } }
Thread synchronization
[edit ]C# provides the lock statement, which is another example of beneficial syntactic sugar. It works by marking a block of code as a critical section by mutual exclusion of access to a provided object. Like the using statement, the compiler generates a try...finally block in its place.
privatestaticStreamWriter_writer; publicvoidConcurrentMethod() { lock(_writer) { _writer.WriteLine("Line 1."); _writer.WriteLine("Followed by line 2."); } }
Attributes
[edit ]Attributes are entities of data that are stored as metadata in the compiled assembly, similar to Java annotations. An attribute can be added to types and members like properties and methods. Attributes can be used for better maintenance of preprocessor directives.
[CompilerGenerated] publicclass$AnonymousType$120 { [CompilerGenerated] publicstringName{get;set;} }
The .NET Framework comes with predefined attributes that can be used. Some of them serve an important role at runtime, while others are just for syntactic decoration in code like CompilerGenerated. It only marks that it is a compiler-generated element. Programmer-defined attributes can also be created.
An attribute is essentially a class that inherits from the System.Attribute class. By convention, attribute classes end with "Attribute" in their name. This is not required when using it.
publicclassEdibleAttribute:Attribute { publicEdibleAttribute():base() { } publicEdibleAttribute(boolisNotPoisonous) { this.IsPoisonous=!isNotPoisonous; } publicboolIsPoisonous{get;set;} }
Showing the attribute in use using the optional constructor parameters.
[Edible(true)] publicclassPeach:Fruit { // Members if any }
Preprocessor
[edit ]C# features "preprocessor directives"[24] (though it does not have an actual preprocessor) based on the C preprocessor that allows programmers to define symbols, but not macros. C# does not use the C preprocessor, but evaluates the code directly as if the preprocessor were there. Conditionals such as #if, #endif, and #else are provided, but code inclusion directives like #include and #embed are not supported.
Directives such as #region give hints to editors for code folding. The #region block must be terminated with a #endregion directive.
publicclassFoo { #region Constructors publicFoo(){} publicFoo(intfirstParam){} #endregion #region Methods publicvoidIntBar(intfirstParam){} publicvoidStrBar(stringfirstParam){} publicvoidBoolBar(boolfirstParam){} #endregion }
Code comments
[edit ]C# utilizes a double slash (//) to indicate the rest of the line is a comment.
publicclassFoo { // a comment publicstaticvoidBar(intfirstParam){}// Also a comment }
Multi-line comments can be indicated by a starting slash/asterisk (/*) and ending asterisk/forward slash (*/).
publicclassFoo { /* A multi-line comment */ publicstaticvoidBar(intfirstParam){} }
Comments do not nest. These are two single comments:
// Can put /* */ */ */ /* /*
/* Can put /* /* /* but it ends with */
Single-line comments beginning with three slashes are used for XML documentation. This, however, is a Visual Studio convention and is not part of the language definition:
/// <summary> /// This class is very classy. /// </summary>
XML documentation comments
[edit ]C#'s documentation comments[25] are similar to Java's Javadoc, but based on XML. Two methods of documentation are supported by the compiler.
Single-line documentation comments, such as those commonly found in Visual Studio generated code, are indicated on a line beginning with ///.
publicclassFoo { /// <summary>A summary of the method.</summary> /// <param name="firstParam">A description of the parameter.</param> /// <remarks>Remarks about the method.</remarks> publicstaticvoidBar(intfirstParam){} }
Multi-line documentation comments, while defined in the version 1.0 language specification, were not supported until the .NET 1.1 release.[26] These comments are designated by a starting forward slash/asterisk/asterisk (/**) and ending asterisk/forward slash (*/).[27]
publicclassFoo { /** <summary>A summary of the method.</summary> * <param name="firstParam">A description of the parameter.</param> * <remarks>Remarks about the method.</remarks> */ publicstaticvoidBar(intfirstParam){} }
Stringent criteria governs white space and XML documentation when using the forward slash/asterisk/asterisk (/**) technique.
This code block:
/** * <summary> * A summary of the method.</summary>*/
produces a different XML comment than this code block:[27]
/** * <summary> A summary of the method.</summary>*/
Syntax for documentation comments and their XML markup is defined in a non-normative annex of the ECMA C# standard. The same standard also defines rules for processing of such comments, and their transformation to a plain XML document with precise rules for mapping of Common Language Infrastructure (CLI) identifiers to their related documentation elements. This allows any C# integrated development environment (IDE) or other development tool to find documentation for any symbol in the code in a certain well-defined way.
Async-await syntax
[edit ]- This is a feature of C# 5.0 and .NET Framework 4.0.
As of .NET Framework 4 a task library makes it easier to write parallel and multi-threaded applications through tasks.
C# 5.0 has native language support for asynchrony, e.g:
publicstaticclassSomeAsyncCode { publicstaticTask<XDocument>GetContentAsync() { HttpClienthc=newHttpClient(); returnhc.GetStringAsync("https://www.contoso.com/").ContinueWith((task)=>{ stringresponseBodyAsText=task.Result; returnXDocument.Parse(responseBodyAsText); }); } } vart=SomeAsyncCode.GetContentAsync().ContinueWith((task)=>{ XDocumentxmlDocument=task.Result; }); t.Start();
The same logic written in the async-await syntax:
publicstaticclassSomeAsyncCode { publicstaticasyncTask<XDocument>GetContentAsync() { HttpClienthc=newHttpClient(); stringresponseBodyAsText=awaithc.GetStringAsync("https://www.contoso.com/"); returnXDocument.Parse(responseBodyAsText); } } XDocumentxmlDocument=awaitSomeAsyncCode.GetContentAsync(); // The Task will be started on call with await.
Dialects
[edit ]Spec#
[edit ]Spec# is a dialect of C# developed in parallel with the official implementation. It extends C# with specification language features and presents a possible future feature to the C# language. It adds syntax for the code contracts API that was introduced in .NET Framework 4.0. Spec# is developed by Microsoft Research.[citation needed ]
This sample shows two of the basic structures that are used when adding contracts to code.
staticvoidMain(string![]args) requiresargs.Length>0 { foreach(stringarginargs) { } }
!is used to make a reference type non-nullable, e.g. it is not possible to set the value to null. This in contrast of nullable types which allow value types to be set as null.requiresindicates a condition that must be followed in the code. In this case the length of args is not allowed to be zero or less.
Non-nullable types
[edit ]Spec# extends C# with non-nullable types that checks so the variables of nullable types that has been set as non-nullable are not null. If is null then an exception is thrown.
string!input
In use:
publicTest(string!input) { ... }
Preconditions
[edit ]Preconditions are checked before a method is executed.
publicTest(inti) requiresi>0; { this.i=i; }
Postconditions
[edit ]Postconditions are conditions that are ensured to be correct when a method has been executed.
publicvoidIncrement() ensuresi>0; { i++; }
Checked exceptions
[edit ]Spec# adds checked exceptions like those in Java.
// SomeException extends ICheckedException publicvoidDoSomething()throwsSomeException { ... }
Checked exceptions may be inconvenient, because when a lower-level function adds a new exception type, the whole chain of methods using this method at some nested lower level must also change its contract. This violates the open/closed principle.[28] However, checked exceptions are designed to be immediately handled rather than continuously thrown up the stack.
See also
[edit ]- .NET Framework
- C# (programming language)
- C++ syntax
- C syntax
- Java syntax
- Microsoft Developer Network
- Microsoft Visual C#
- Mono (software)
- Outline of the C# programming language
References
[edit ]- ^ "C# Coding Conventions". Microsoft Learn. sec. Naming conventions. Archived from the original on January 16, 2023.
- ^ a b Wagner, Bill. "C# Keywords". docs.microsoft.com. Retrieved August 26, 2022.
- ^ Schildt, Herbert (December 30, 2008), C# 3.0: The Complete Reference, ISBN 9780071588416
- ^ Deitel, Harvey M.; Deitel, Paul J. (November 21, 2005), C# for programmers, ISBN 9780132465915
- ^ Wagner, Bill. "C# Keywords". docs.microsoft.com. Retrieved August 26, 2022.
- ^ a b Wagner, Bill. "Integral numeric types". learn.microsoft.com. Retrieved October 27, 2024.
- ^ Wagner, Bill. "Floating-point numeric types". learn.microsoft.com. Retrieved October 27, 2024.
- ^ Wagner, Bill. "char". learn.microsoft.com. Retrieved October 27, 2024.
- ^ a b Wagner, Bill. "Strings and string literals". learn.microsoft.com. Retrieved October 27, 2024.
- ^ a b Wagner, Bill. "Declaration statements". learn.microsoft.com. Retrieved October 27, 2024.
- ^ Wagner, Bill. "Assignment operators". learn.microsoft.com. Retrieved October 27, 2024.
- ^ Wagner, Bill. "readonly". learn.microsoft.com. Retrieved October 27, 2024.
- ^ "Exploring C# 10: Save Space with File-Scoped Namespaces". Dave Brock. October 5, 2021. Retrieved November 19, 2024.
- ^ Pointer types (C# Programming Guide)
- ^ a b Archer, Part 2, Chapter 4:The Type System
- ^ "Generics (C# Programming Guide)". Microsoft. Retrieved August 7, 2011.
- ^ "An Introduction to C# Generics". Microsoft.
- ^ "Differences Between C++ Templates and C# Generics". Microsoft.
- ^ "An Introduction to C# Generics". Microsoft. January 2005. Retrieved June 18, 2009.
- ^ Constraints on Type Parameters (C# Programming Guide) in Microsoft MSDN
- ^ "yield". C# Language Reference. Microsoft . Retrieved April 26, 2009.
- ^ ".NET Framework - What's New in C# 7.0". msdn.microsoft.com. Retrieved April 8, 2017.
- ^ "Thoughts on C# 7 Local Functions". Anton Sizikov. April 15, 2016. Retrieved April 8, 2017.
- ^ "C# Preprocessor Directives". C# Language Reference. Microsoft . Retrieved June 18, 2009.
- ^ "Documentation comments". Microsoft Learn . June 15, 2023.
- ^ Horton, Anson (September 11, 2006). "C# XML documentation comments FAQ" . Retrieved December 11, 2007.
- ^ a b "Delimiters for Documentation Tags". C# Programmer's Reference. Microsoft. Archived from the original on December 20, 2008. Retrieved June 18, 2009.
- ^ Martin, Robert C. (August 11, 2008). "7 Error Handling, Use Unchecked Exceptions". Clean Code: A Handbook of Agile Software Craftsmanship. Prentice Hall International. ISBN 978-0132350884.
- Archer, Tom (2001). Inside C#. Microsoft Press. ISBN 0-7356-1288-9.
- Bart de Smet on Spec# Archived October 29, 2010, at the Wayback Machine