Software Engineering

Guter Code

oder auch ... blamiert euch nicht unnötig

Gastvortrag von René Meye / @Meye_R

Gäste

Bitte salutieren

• General Purpose
• Major Concern
• Kernel Panic
• Private Static

Notationen

int ínt = 5;

int sobitteauchnichtdaskanndochkeinerlesen = 5;

int _ = 5;
int __ = 8;
int _$__ = _ - ___;

(Fürs Protokoll: Das sind NEGATIV Beispiele!)

CamelCaseNotation

• Worte verbunden mit großen Zeichen
• Üblich bei: Variablen, Funktionen, Klassennamen...
• zu Deutsch: "Binnenmajunkel"
• Erster Buchstabe groß oder klein

    String einBeispiel = "Test";

    int verschiedeneWorteGetrenntDurchEinGroßesZeichenAmAnfang;

    StringWithExtensions test = "Foo Bar";

UPPER_CASE Notation

• Worte getrennt durch Unterstrich
• Üblich für Konstanten

final int FIXED_ARRAY_LENGHT = 42;

final String RANDOM_HASH = "Deine Mudda!";

lower_case Notation

• Worte getrennt durch Unterstrich
• häufig auch zusammen geschrieben
• Üblich für packagenames

package de.ovgu.iti.softwareengineering;

package de.ovgu.iti.software_engineering;

Ungarische Notation

• Apps Hungarian

  mpchgr

  (Array, dessen Elemente Klassen sind und von positiven Bytes indiziert wird.)

• Systems Hungarian

  String m_szLastName;

  (Eine Member-Variable eines null-terminierten Strings.)

Ungarische Notation

A wise man:

• Ungarische Notation wird heute ungerne gesehen.
• Echtes Beispiel:

  a_crszkvc30LastNameCol
  `

beschVaNa

Beschreibende Variablen Namen

• Variablennamen sollten immer ihren Inhalt beschreiben.
• kein einbuchstabigen Variablen
• keine Abkürzungen
• Faul sein: Tippen übernimmt die IDE

foo[p] = sc.nextInt();

// versus

valuesFromUser[inputIndex] = consoleReader.nextInt();

Funktionen

Tour de france

Programmierung

if(a == b){
    if(x==z){
            do something();
        }
        if(c == 0){
            while (flag) {
                flag = false; 
                for (j = 0; j < num.length - 1; j++) {
                    if (num[j] < num[j + 1]){
doAnything();
                    }
                }
            }
            if(b == x){
                while (flag) {
                    flag = false; 
                    for (j = 0; j < num.length - 1; j++) {
if (num[j] < num[j + 1])
{
    doAnything();
}
                    }
                }
            }
            while (en.hasMoreElements()) {
                type type = (type) en.nextElement();
                for (int i = 0; i < args.length; i++) {
                    if(a == b){
if(x==z){
    do something();
}
if(c == 0){
    while (flag) {
        flag = false; 
        for (j = 0; j < num.length - 1; j++) {
            if (num[j] < num[j + 1])
            {
                doAnything();
            }
        }
    }
    if(b == x){
        while (flag) {
            flag = false; 
            for (j = 0; j < num.length - 1; j++) {
                if (num[j] < num[j + 1])
                {
                    doAnything();
                }
            }
        }
    }
}
                    }
                }
            }
        }
    }

Funktionen

• Daumenregel: höchstens sieben Zeilen
• Aufteilen in Teilschritte
  • in eigene Funktionen auslagern
• Beschreibende Funktionsnamen
  • Alles was die Funktion tut

int num[] = new int[5];
System.out.println("Ein:");
Scanner sc = new Scanner(System.in);
for(int p = 0; p<5; p++)
	num[p] = sc.nextInt();
int j;
boolean flag = true; // set flag to true
int temp; // holding variable
while (flag) {
	flag = false; // set flag to false awaiting a possible swap
	for (j = 0; j < num.length - 1; j++) {
		if (num[j] < num[j + 1]) // change to > for ascending sort
		{
			temp = num[j]; // swap elements
			num[j] = num[j + 1];
			num[j + 1] = temp;
			flag = true; // shows a swap occurred
		}
	}
}
int z=0;
for(int t = 0; t<5; t++)
	z += num[t];
System.out.println("Erg:"+z/5.0);

public static void main(String[] args) {
    int arrayOfIntegerValues[] = new int[ARRAY_LENGTH];
    askUserForInput(arrayOfIntegerValues);

    sortWithBubbleSort(arrayOfIntegerValues);
    double meanValue = calculateMeanValue(arrayOfIntegerValues);

    printResultToConsole(meanValue);
}

Kommentare

Kommentare

• Guter Code:
  • Beschreibende Variablennamen
  • Beschreibende Funktionsnamen
  • Einheitliche Notation
  • Einzelschritte in eigene Funktionen ausgelagert
  • "Guter Code darf keine Kommentare brauchen."

Kommentare

• Guter Code soll trozdem Kommentare beinhalten:

/**
  * @param front will be the first part 
  * @param middlepart will be the second part
  * @param end will be the last part
  * @return A concatenated String for the three params
  */
public static String concatenate(String front,String middlepart,String end){
   ...
}

/**
  * @version 4.2  März 2013
  * @author René Meye.
    * This class proviedes some additional mathematical functions.
  */
public class Mathematics {
...
}

Kommentare

• können schädlich sein

  • Verrutschter Kommentar

      //STEP 1: Sort all Elements
      test[0] = null;
    
      Array.sort(test);

  • Verwirrender Kommentar

    int config = 2231832; //RIPJWvG

viele Weitere: Stackoverflow - best comment in source code

Code Conventions

Code-Conventions

• Regel wie Code zu schreiben ist
• Werden bei Bewerbungen überprüft
• Wird vorgegeben
• Beispiel:
  • Java-Code-Conventions
• In fast allen Programmiersprachen verfügbar

Java-Code-Conventions

• File Names
• File Organization
• Indentation
• Comments
• Declarations
• Statements
• White Space
• Naming Conventions
• ...