Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
0% found this document useful (0 votes)
8 views

c# Programming

The document provides an overview of the structure and components of a C# program, including the 'Hello World!' example, coding conventions, and identifier naming rules. It discusses the importance of layout and commenting conventions for readability and maintenance. Additionally, it outlines best practices for using data types, exception handling, and object instantiation in C#.

Uploaded by

adil
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
8 views

c# Programming

The document provides an overview of the structure and components of a C# program, including the 'Hello World!' example, coding conventions, and identifier naming rules. It discusses the importance of layout and commenting conventions for readability and maintenance. Additionally, it outlines best practices for using data types, exception handling, and object instantiation in C#.

Uploaded by

adil
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 16

Contents

Inside a C# Program
Hello World -- Your First Program
General Structure of a C# Program
Identifier names
C# Coding Conventions
Inside a C# program
8/19/2019 • 2 minutes to read • Edit Online

The section discusses the general structure of a C# program, and includes the standard "Hello, World!" example.

In this section
Hello World -- Your First Program
General Structure of a C# Program
Identifier names
C# Coding Conventions

Related sections
Getting Started with C#
C# Programming Guide
C# Reference
Samples and tutorials

C# language specification
For more information, see the C# Language Specification. The language specification is the definitive source for C#
syntax and usage.

See also
C# Programming Guide
Hello World -- Your first program
9/14/2019 • 4 minutes to read • Edit Online

In this article, you'll use Visual Studio to create the traditional "Hello World!" program. Visual Studio is a
professional Integrated Development Environment (IDE ) with many features designed for .NET development.
You'll use only a few of the features in Visual Studio to create this program. To learn more about Visual Studio, see
Getting Started with Visual C# and Visual Basic.

NOTE
Your computer might show different names or locations for some of the Visual Studio user interface elements in the following
instructions. The Visual Studio edition that you have and the settings that you use determine these elements. For more
information, see Personalizing the IDE.

Create a new application


Windows
macOS
Start Visual Studio. You'll see the following image on Windows:

Select Create a new project in the lower right corner of the image. Visual Studio displays the New Project
dialog:
NOTE
If this is the first time you've started Visual Studio, the Recent project templates list is empty.

On the new project dialog, choose "Console App (.NET Core)" and then press Next. Give your project a name,
such as "HelloWorld", then press Create.
Visual Studio opens your project. It's already a basic "Hello World!" example. Press Ctrl + F5 to run your
project. Visual Studio builds your project, converting the source code into an executable. Then, it launches a
command window that runs your new application. You should see the following text in the window:

Hello World!

C:\Program Files\dotnet\dotnet.exe (process 11964) exited with code 0.


Press any key to close this window . . .

Press a key to close the window.

Elements of a C# program
Let's examine the important parts of this program. The first line contains a comment. The characters // convert
the rest of the line to a comment.

// A Hello World! program in C#.

You can also comment out a block of text by enclosing it between the /* and */ characters. This is shown in the
following example.
/* A "Hello World!" program in C#.
This program displays the string "Hello World!" on the screen. */

A C# console application must contain a Main method, in which control starts and ends. The Main method is
where you create objects and execute other methods.
The Main method is a static method that resides inside a class or a struct. In the previous "Hello World!" example,
it resides in a class named Hello . You can declare the Main method in one of the following ways:
It can return void . That means your program doesn't return a value.

static void Main()


{
//...
}

It can also return an integer. The integer is the exit code for your application.

static int Main()


{
//...
return 0;
}

With either of the return types, it can take arguments.

static void Main(string[] args)


{
//...
}

-or-

static int Main(string[] args)


{
//...
return 0;
}

The parameter of the Main method, args , is a string array that contains the command-line arguments used to
invoke the program.
For more information about how to use command-line arguments, see the examples in Main() and Command-Line
Arguments.

Input and output


C# programs generally use the input/output services provided by the run-time library of the .NET Framework. The
statement System.Console.WriteLine("Hello World!"); uses the WriteLine method. This is one of the output
methods of the Console class in the run-time library. It displays its string parameter on the standard output stream
followed by a new line. Other Console methods are available for different input and output operations. If you
include the using System; directive at the beginning of the program, you can directly use the System classes and
methods without fully qualifying them. For example, you can call Console.WriteLine instead of
System.Console.WriteLine :
using System;

Console.WriteLine("Hello World!");

For more information about input/output methods, see System.IO.

See also
C# Programming Guide
Samples and tutorials
Main() and Command-Line Arguments
Getting Started with Visual C# and Visual Basic
General Structure of a C# Program (C# Programming
Guide)
8/19/2019 • 2 minutes to read • Edit Online

C# programs can consist of one or more files. Each file can contain zero or more namespaces. A namespace can
contain types such as classes, structs, interfaces, enumerations, and delegates, in addition to other namespaces. The
following is the skeleton of a C# program that contains all of these elements.

// A skeleton of a C# program
using System;
namespace YourNamespace
{
class YourClass
{
}

struct YourStruct
{
}

interface IYourInterface
{
}

delegate int YourDelegate();

enum YourEnum
{
}

namespace YourNestedNamespace
{
struct YourStruct
{
}
}

class YourMainClass
{
static void Main(string[] args)
{
//Your program starts here...
}
}
}

Related Sections
For more information:
Classes
Structs
Namespaces
Interfaces
Delegates

C# Language Specification
For more information, see Basic concepts in the C# Language Specification. The language specification is the
definitive source for C# syntax and usage.

See also
C# Programming Guide
Inside a C# Program
C# Reference
Identifier names
8/19/2019 • 2 minutes to read • Edit Online

An identifier is the name you assign to a type (class, interface, struct, delegate, or enum), member, variable, or
namespace. Valid identifiers must follow these rules:
Identifiers must start with a letter, or _ .
Identifiers may contain Unicode letter characters, decimal digit characters, Unicode connecting characters,
Unicode combining characters, or Unicode formatting characters. For more information on Unicode categories,
see the Unicode Category Database. You can declare identifiers that match C# keywords by using the @ prefix
on the identifier. The @ is not part of the identifier name. For example, @if declares an identifier named if .
These verbatim identifiers are primarily for interoperability with identifiers declared in other languages.
For a complete definition of valid identifiers, see the Identifiers topic in the C# Language Specification.

Naming conventions
In addition to the rules, there are a number of identifier naming conventions used throughout the .NET APIs. By
convention, C# programs use PascalCase for type names, namespaces, and all public members. In addition, the
following conventions are common:
Interface names start with a capital I .
Attribute types end with the word Attribute .
Enum types use a singular noun for non-flags, and a plural noun for flags.
Identifiers should not contain two consecutive _ characters. Those names are reserved for compiler generated
identifiers.

C# Language Specification
For more information, see the C# Language Specification. The language specification is the definitive source for C#
syntax and usage.

See also
C# Programming Guide
Inside a C# Program
C# Reference
Classes
Structs
Namespaces
Interfaces
Delegates
C# Coding Conventions (C# Programming Guide)
8/19/2019 • 8 minutes to read • Edit Online

Coding conventions serve the following purposes:


They create a consistent look to the code, so that readers can focus on content, not layout.
They enable readers to understand the code more quickly by making assumptions based on previous
experience.
They facilitate copying, changing, and maintaining the code.
They demonstrate C# best practices.
The guidelines in this topic are used by Microsoft to develop samples and documentation.

Naming Conventions
In short examples that do not include using directives, use namespace qualifications. If you know that a
namespace is imported by default in a project, you do not have to fully qualify the names from that
namespace. Qualified names can be broken after a dot (.) if they are too long for a single line, as shown in
the following example.

var currentPerformanceCounterCategory = new System.Diagnostics.


PerformanceCounterCategory();

You do not have to change the names of objects that were created by using the Visual Studio designer tools
to make them fit other guidelines.

Layout Conventions
Good layout uses formatting to emphasize the structure of your code and to make the code easier to read.
Microsoft examples and samples conform to the following conventions:
Use the default Code Editor settings (smart indenting, four-character indents, tabs saved as spaces). For
more information, see Options, Text Editor, C#, Formatting.
Write only one statement per line.
Write only one declaration per line.
If continuation lines are not indented automatically, indent them one tab stop (four spaces).
Add at least one blank line between method definitions and property definitions.
Use parentheses to make clauses in an expression apparent, as shown in the following code.

if ((val1 > val2) && (val1 > val3))


{
// Take appropriate action.
}

Commenting Conventions
Place the comment on a separate line, not at the end of a line of code.
Begin comment text with an uppercase letter.
End comment text with a period.
Insert one space between the comment delimiter (//) and the comment text, as shown in the following
example.

// The following declaration creates a query. It does not run


// the query.

Do not create formatted blocks of asterisks around comments.

Language Guidelines
The following sections describe practices that the C# team follows to prepare code examples and samples.
String Data Type
Use string interpolation to concatenate short strings, as shown in the following code.

string displayName = $"{nameList[n].LastName}, {nameList[n].FirstName}";

To append strings in loops, especially when you are working with large amounts of text, use a StringBuilder
object.

var phrase = "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";


var manyPhrases = new StringBuilder();
for (var i = 0; i < 10000; i++)
{
manyPhrases.Append(phrase);
}
//Console.WriteLine("tra" + manyPhrases);

Implicitly Typed Local Variables


Use implicit typing for local variables when the type of the variable is obvious from the right side of the
assignment, or when the precise type is not important.

// When the type of a variable is clear from the context, use var
// in the declaration.
var var1 = "This is clearly a string.";
var var2 = 27;
var var3 = Convert.ToInt32(Console.ReadLine());

Do not use var when the type is not apparent from the right side of the assignment.

// When the type of a variable is not clear from the context, use an
// explicit type.
int var4 = ExampleClass.ResultSoFar();

Do not rely on the variable name to specify the type of the variable. It might not be correct.
// Naming the following variable inputInt is misleading.
// It is a string.
var inputInt = Console.ReadLine();
Console.WriteLine(inputInt);

Avoid the use of var in place of dynamic.


Use implicit typing to determine the type of the loop variable in for and foreach loops.
The following example uses implicit typing in a for statement.

var phrase = "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";


var manyPhrases = new StringBuilder();
for (var i = 0; i < 10000; i++)
{
manyPhrases.Append(phrase);
}
//Console.WriteLine("tra" + manyPhrases);

The following example uses implicit typing in a foreach statement.

foreach (var ch in laugh)


{
if (ch == 'h')
Console.Write("H");
else
Console.Write(ch);
}
Console.WriteLine();

Unsigned Data Type


In general, use int rather than unsigned types. The use of int is common throughout C#, and it is easier to
interact with other libraries when you use int .
Arrays
Use the concise syntax when you initialize arrays on the declaration line.

// Preferred syntax. Note that you cannot use var here instead of string[].
string[] vowels1 = { "a", "e", "i", "o", "u" };

// If you use explicit instantiation, you can use var.


var vowels2 = new string[] { "a", "e", "i", "o", "u" };

// If you specify an array size, you must initialize the elements one at a time.
var vowels3 = new string[5];
vowels3[0] = "a";
vowels3[1] = "e";
// And so on.

Delegates
Use the concise syntax to create instances of a delegate type.
// First, in class Program, define the delegate type and a method that
// has a matching signature.

// Define the type.


public delegate void Del(string message);

// Define a method that has a matching signature.


public static void DelMethod(string str)
{
Console.WriteLine("DelMethod argument: {0}", str);
}

// In the Main method, create an instance of Del.

// Preferred: Create an instance of Del by using condensed syntax.


Del exampleDel2 = DelMethod;

// The following declaration uses the full syntax.


Del exampleDel1 = new Del(DelMethod);

try-catch and using Statements in Exception Handling


Use a try-catch statement for most exception handling.

static string GetValueFromArray(string[] array, int index)


{
try
{
return array[index];
}
catch (System.IndexOutOfRangeException ex)
{
Console.WriteLine("Index is out of range: {0}", index);
throw;
}
}

Simplify your code by using the C# using statement. If you have a try-finally statement in which the only
code in the finally block is a call to the Dispose method, use a using statement instead.

// This try-finally statement only calls Dispose in the finally block.


Font font1 = new Font("Arial", 10.0f);
try
{
byte charset = font1.GdiCharSet;
}
finally
{
if (font1 != null)
{
((IDisposable)font1).Dispose();
}
}

// You can do the same thing with a using statement.


using (Font font2 = new Font("Arial", 10.0f))
{
byte charset = font2.GdiCharSet;
}
&& and || Operators
To avoid exceptions and increase performance by skipping unnecessary comparisons, use && instead of &
and || instead of | when you perform comparisons, as shown in the following example.

Console.Write("Enter a dividend: ");


var dividend = Convert.ToInt32(Console.ReadLine());

Console.Write("Enter a divisor: ");


var divisor = Convert.ToInt32(Console.ReadLine());

// If the divisor is 0, the second clause in the following condition


// causes a run-time error. The && operator short circuits when the
// first expression is false. That is, it does not evaluate the
// second expression. The & operator evaluates both, and causes
// a run-time error when divisor is 0.
if ((divisor != 0) && (dividend / divisor > 0))
{
Console.WriteLine("Quotient: {0}", dividend / divisor);
}
else
{
Console.WriteLine("Attempted division by 0 ends up here.");
}

New Operator
Use the concise form of object instantiation, with implicit typing, as shown in the following declaration.

var instance1 = new ExampleClass();

The previous line is equivalent to the following declaration.

ExampleClass instance2 = new ExampleClass();

Use object initializers to simplify object creation.

// Object initializer.
var instance3 = new ExampleClass { Name = "Desktop", ID = 37414,
Location = "Redmond", Age = 2.3 };

// Default constructor and assignment statements.


var instance4 = new ExampleClass();
instance4.Name = "Desktop";
instance4.ID = 37414;
instance4.Location = "Redmond";
instance4.Age = 2.3;

Event Handling
If you are defining an event handler that you do not need to remove later, use a lambda expression.
public Form2()
{
// You can use a lambda expression to define an event handler.
this.Click += (s, e) =>
{
MessageBox.Show(
((MouseEventArgs)e).Location.ToString());
};
}

// Using a lambda expression shortens the following traditional definition.


public Form1()
{
this.Click += new EventHandler(Form1_Click);
}

void Form1_Click(object sender, EventArgs e)


{
MessageBox.Show(((MouseEventArgs)e).Location.ToString());
}

Static Members
Call static members by using the class name: ClassName.StaticMember. This practice makes code more
readable by making static access clear. Do not qualify a static member defined in a base class with the name of a
derived class. While that code compiles, the code readability is misleading, and the code may break in the future
if you add a static member with the same name to the derived class.
LINQ Queries
Use meaningful names for query variables. The following example uses seattleCustomers for customers
who are located in Seattle.

var seattleCustomers = from customer in customers


where customer.City == "Seattle"
select customer.Name;

Use aliases to make sure that property names of anonymous types are correctly capitalized, using Pascal
casing.

var localDistributors =
from customer in customers
join distributor in distributors on customer.City equals distributor.City
select new { Customer = customer, Distributor = distributor };

Rename properties when the property names in the result would be ambiguous. For example, if your query
returns a customer name and a distributor ID, instead of leaving them as Name and ID in the result,
rename them to clarify that Name is the name of a customer, and ID is the ID of a distributor.

var localDistributors2 =
from customer in customers
join distributor in distributors on customer.City equals distributor.City
select new { CustomerName = customer.Name, DistributorID = distributor.ID };

Use implicit typing in the declaration of query variables and range variables.
var seattleCustomers = from customer in customers
where customer.City == "Seattle"
select customer.Name;

Align query clauses under the from clause, as shown in the previous examples.
Use where clauses before other query clauses to ensure that later query clauses operate on the reduced,
filtered set of data.

var seattleCustomers2 = from customer in customers


where customer.City == "Seattle"
orderby customer.Name
select customer;

Use multiple from clauses instead of a join clause to access inner collections. For example, a collection of
Student objects might each contain a collection of test scores. When the following query is executed, it
returns each score that is over 90, along with the last name of the student who received the score.

// Use a compound from to access the inner sequence within each element.
var scoreQuery = from student in students
from score in student.Scores
where score > 90
select new { Last = student.LastName, score };

Security
Follow the guidelines in Secure Coding Guidelines.

See also
Visual Basic Coding Conventions
Secure Coding Guidelines

You might also like