Coding mit Stil

Programmierstil

Grundlegendes

• Es sollte immer die englische Sprache verwendet werden, sei es für Variablennamen, Erklärungen, Meldungen fürs Logfile oder auch der Ausgabe von Plugins.
• Verwende keine Hard-Tabs, sondern immer Soft-Tabs mit einer Länge von 4 Leerzeichen.
• Für die Einrückung sollten immer 4 Leerzeichen (1 Soft-Tab) verwendet werden.
• Halte den Codingstyle der Programmiersprache bei, welche verwendet wird, jedoch unter Beachtung der oberen Punkte.

Perl

Sollte die Programmiersprache Perl verwendet werden, so finden Sie hier einen Codingstyle: Perlstyle

Verwende kein CamelCase:

my $someVariableThatContainsData =
    someSubroutineThatProcessDataAndReturnsItBack( $someAwfulVariable );

Verwende snake_case, denn das ist deutlich lesbarer:

my $some_variable_that_contains_data =
    some_subroutine_that_process_data_and_returns_it_back( $some_awful_variable );

Verhindere unnötiges Zeichenrauschen. Schreib lesbar. Statt

if(ref($data) eq "HASH")
{

schreib es so:

if (ref $data eq "HASH") {

oder statt

my %hash = ("foo" => 1, "bar" => 2, "baz" => 3);

geht es auch so:

my %hash = (foo => 1, bar => 2, baz => 3);

Noch ein paar schlechte Beispiele:

foreach my $var (qw(a b c)) {

$var =~ s/\/\/a\/\//b/g;

my $var = join(",",$a,$b,@c,"and this");

open(FH,">$foo") or die $!;

So geht es lesbarer

foreach my $var (qw/a b c/) {

$var =~ s!//a//!b!g;

$var = join(",", $a, $b, @c, "and this");

open my $fh, ">", $foo or die $!;

Bitte lokalisiere Variablen mit my!

Der Bloonix Code

Wenn Sie in den Code von Bloonix blicken, dann werden Sie sicherlich Codestellen finden, die nicht optimal sind. Wie das in vielen Softwareprojekten der Fall ist, gibt es oft Code, der schon lange existiert und gewachsen ist. Oder es gibt Funktionen/Methoden, die man mal eben um ein paar Zeilen erweitert, ohne auf die Länge der Funktion/Methode zu achten.

Mit der Zeit werden auch diese Codestellen überarbeitet... es ist halt immer eine Frage der Zeit :-)