CloudMarketing

Häufig findet sich eine Vielzahl kleinerer und größerer Fehler in der Dokumentation des Quellcodes von Web- und Desktop-Anwendungen. Das Dokumentieren in JavaDoc oder PHPDoc ist prinzipiell einfach, doch mitunter wird durch das Entwickler-Team nicht das Richtige oder nur unvollständig dokumentiert.

In manchen Programmiersprachen sind solche Nachlässigkeiten weniger dramatisch, doch gerade in Java oder PHP kann dies zu erheblichem Mehraufwand in der späteren Wartung führen. Wird der Source an einen Kunden ausgeliefert, entsteht zudem ein schlechter Eindruck, da Quellcode-Kommentare neben der Klassenstruktur zu den ersten Punkten eines Reviews gehören.

In jeder Programmiersprache gibt es sogenannte „Style Guides“ wie zum Beispiel für Java von Sun. Ein Style Guide kann als Vorlage verstanden werden, die einem Entwickler vorgibt, wie sein Quellcode aufgebaut sein sollte. Neben der Verwendung von JavaDoc oder PHPDoc umfasst dies auch häufig die Bezeichnung der Variablen.

Mit Sicherheit können Software-Entwickler ihren eigenen Stil entwickeln, nur zu weit sollte man sich von der Grundlage nicht entfernen – denn das kann zu einem Chaos innerhalb des Entwickler-Teams führen. Die Praxis zeigt, die Konsequenz ist häufig die Neuentwicklung.

Empfehlungen: Code Conventions for the Java Programming Language, CodeIgniter PHP Style Guide

Diese Icons verlinken auf Bookmark Dienste bei denen Nutzer neue Inhalte finden und mit anderen teilen können.

• 
• 
• 
• 
• 
• 
•