Entwicklerleitfaden / Leitfaden Codestyle

Klasse

Engl.

PascalCase

Eine Klasse pro Datei

Darstellung

Aufbau von Klassen, Klassen/Interface-Deklaration, Felder, Properties, Konstruktor, Methoden.
Pro Datentyp 1 View.

Interface

Engl.

PascalCase

public IMyInterface
#Name beginnt mit I

Feldname

Engl.

PascalCase

public String InvNumber {get; set; }

Methode

Engl.

PascalCase

public void Calculation
#Aktive Verb-Nomen-Form

Variable

Engl.

CamelCase

String invoiceNumber

Instanzvariable

Engl.

CamelCase

private String invoiceNumber
#keinen führenden Unterstrich

Parameter

Engl.

CamelCase

DoCalculation(int cntPos, decimal pricePos)

Konstanten

Engl.

PascalCase

const int NumDaysOfWeek =  4

Events

Engl.

PascalCase

MouseEventHandler(object sender, MouseEventsArgs e)

GUI

Dt.

PascalCase

Komponente

Engl.

PascalCase

DB-Tabelle

Engl.

Lowercase

public String eq_invNumber {get; set; }

DB-Spalte

Engl.

Kleinschreibung

lastname_new
#nicht EmployeeLastName

Kommentare

Dt. / Engl.

-

Bei neuralgischen Punkten in Englisch kommentieren

Klasse

Engl.

Lowercase

Eine Klasse pro Datei

Darstellung

Engl.

Aufbau von Klassen, Klassen/Interface-Deklaration, Felder, Properties, Konstruktor, Methoden

Feldname

Engl.

Lowercase

eq_invnumber

Methode

Engl.

Lowercase

def myfunction(self):

Variable

Engl.

Lowercase

eq_invoicenumber

Instanzvariable

Engl.

Lowercase

_eq_invoicenumber

Parameter

Engl.

Lowercase

sprechende Namen verwenden

Konstanten

Engl.

Uppercase

CONST_DATA = 4

DB-Tabelle

Engl.

Lowercase

eq_datatable oder eq_data.table (eq_ Präfix)

DB-Spalte

Engl.

Lowercase

eq_lastname (eq_ Präfix)

Kommentare

Dt. / Engl.

-

Bei neuralgischen Punkten in Englisch kommentieren

Class

engl.

PascalCase

One class per file.

View

engl.

-

Structure of classes, class/interface declaration, fields, properties, constructor, methods.
One view per data type.

Interface

engl.

PascalCase

public IMyInterface
#Name begins with I

Field name

engl.

PascalCase

public String InvNumber {get; set; }

Method

engl.

PascalCase

public void Calculation
#Active verb-nomenal form

Variabel

engl.

CamelCase

String invoiceNumber

Instance variable

engl.

CamelCase

private String invoiceNumber
#no leading underscore

Parameter

engl.

CamelCase

DoCalculation(int cntPos, decimal pricePos)

Constants

engl.

PascalCase

const int NumDaysOfWeek =  4

Events

engl.

PascalCase

MouseEventHandler(object sender, MouseEventsArgs e)

GUI

ger.

PascalCase

Component

engl.

PascalCase

DB table

engl.

Lowercase

public String eq_invNumber {get; set; }

DB column

engl.

Lowercase

lastname_new
#not EmployeeLastName

Comments

ger. / engl.

CamelCase

Bei neuralgischen Punkten in Englisch kommentieren

Class

engl.

Lowercase

One class per file. Use the eq_{classname} prefix

View

Structure of classes, class/interface declaration, fields, properties, constructor, methods

Field name

engl.

Lowercase

eq_invnumber

Method

engl.

Lowercase

def myfunction(self):

Variabel

engl.

Lowercase

eq_invoicenumber

Instance variable

engl.

Lowercase

_eq_invoicenumber

Parameter

engl.

Lowercase

use significiant names

Constants

engl.

Uppercase

CONST_DATA = 4

DB table

engl.

Lowercase

eq_datatable or eq_data.table (eq_ prefix)

DB column

engl.

Lowercase

eq_lastname (eq_ prefix)

Comments

ger. / engl.

-

In areas where difficulties may occur use english

Label

lbl {name}

Text

txt {name}

Checkbox

cbx {name}

Div

div {name}

Dropdown

ddl {name}

Button

btn {name}

Table

tbl {name}

Radiobutton

rdb {name}

Image

img {name}

Label

lbl {name}

Text

txt {name}

Checkbox

cbx {name}

Div

div {name}

Dropdown

ddl {name}

Button

btn {name}

Table

tbl {name}

Radiobutton

rdb {name}

Image

img {name}

<summary>

x

x

x

Eine Zusammenfassung des Objekts
<summary>Ermitteln Rechnungssumme</summary>

<returns>

x