Good written code

Слайд 2

Some important best practices for writing readable code: 1 - Commenting

Some important best practices for writing readable code:

1 - Commenting &

Documentation

The comment should disclose things that can not be immediately learned from the code.

Слайд 3

2 - Consistent Indentation But that is only a matter of

2 - Consistent Indentation

But that is only a matter of preference.

There is no "best" style that everyone should be following. Actually, the best style, is a consistent style. If you are part of a team or if you are contributing code to a project, you should follow the existing style that is being used in that project.
Слайд 4

When you use unclear and non-descript names for variables, classes, and

When you use unclear and non-descript names for variables, classes, and

functions, you’re essentially obfuscating the application logic from any programmer who reads the code, including yourself.

3. Use Descriptive Names

What does a variable named dxy actually mean? Who knows. You’d probably have to read the entire chunk of code to reverse engineer its meaning. On the other hand, the meaning of a variable like distanceBetweenXY is instantly recognizable.

But, this doesn't necessarily apply to temporary variables. They can be as short as a single character.

Consistent Naming Scheme

mysql_real_escape_string()

MysqlRealEscapeString()

Слайд 5

4 - Avoid Obvious Comments

4 - Avoid Obvious Comments

Слайд 6

5 - Code Grouping

5 - Code Grouping

Слайд 7

6 - DRY Principle DRY stands for Don't Repeat Yourself. Also

6 - DRY Principle

DRY stands for Don't Repeat Yourself. Also known

as DIE: Duplication is Evil.
Слайд 8

7 - Avoid Deep Nesting Too many levels of nesting can

7 - Avoid Deep Nesting

Too many levels of nesting can make

code harder to read and follow.
Слайд 9

Functions and procedures

Functions and procedures   

Слайд 10

Computer programs can consist of thousands of lines of code, just

Computer programs can consist of thousands of lines of code, just

like a textbook can have thousands of words.
In the same way that a textbook is divided into chapters, a program is divided into related functionality using modules.
Слайд 11

The C # program is built from modules, the role of

The C # program is built from modules, the role of

which is performed by classes.
The functionality of the class is provided by methods.

In C #, these methods are of two kinds: procedures and functions.

The syntax for declaring a method allows you to uniquely determine what the method is, a procedure or a function.

Слайд 12

void (parameters) { body procedures } (parameters) { Body functions Return

void (parameters)
{
body procedures
}

(parameters)
{
Body

functions
Return ;
}

Example

What is the class name?
How many methods does the class include?
What are the names of these methods?
What access modifier?
What kind of methods, procedures or functions?
What events correspond to the methods?
What actions are performed when these methods are called?
What parameters?

Слайд 13

Global variable - declared at the start of the program, their

Global variable - declared at the start of the program, their global scope means

they can be used in any procedure or subroutine in the program

Local variable declared within subroutines or programming blocks, their local scope means they can only be used within the subroutine or program block they were declared in

Слайд 14

void (parameters) { body procedures } (parameters) { Body functions Return

void (parameters)
{
body procedures
}

(parameters)
{
Body

functions
Return ;
}

What are the differences?

Слайд 15

What are the procedures and functions for? They help you structure

What are the procedures and functions for?

They help you structure your

code
They allow you to create a common routine once and re-use as many times as you want
They allow you to share code with other programs
They allow you to test sub routines independently of the rest of the code
Слайд 16

Draw a triangle and calculate its area

Draw a triangle and calculate its area

Слайд 17

Слайд 18

Слайд 19

Слайд 20

Слайд 21