Tipps und Tricks: Namensregeln und Kommentierung

Namensregeln bzw. korrekterweise als Namenskonventionen bezeichnet sind Empfehlungen, welche einen im Allgemeinen besser lesbaren und strukturierten Programmcode mit sich bringen sollen. Diese „Regeln“ müssen keinesfalls eingehalten werden und können sich von Programmiersprache zu Programmiersprache unterscheiden. Einige Programmierer halten sich daran, andere wiederum nicht.
Wie wir bereits am Anfang dieses Kurses angesprochen haben, sollten alle Variablennamen mit einem Kürzel versehen werden, welche den Datentyp widerspiegeln (z. B. eine 32bit-Ganzzahl namens „Test“ sollte iTest genannt werden). Auch die Einrückung eines Programmcodes sollte beachtet werden (zumeist ein Tab bzw. 4 Leerzeichen für eine Unterordnung). Klassennamen, Enumerationstypen und -werte, Funktionen, Eigenschaften und Namensräume sollten mit einem Großbuchstaben beginnen. Werden mehrere Wörter verwendet, so werden die Anfangsbuchstaben jeden Wortes ebenfalls wieder groß geschrieben (z. B. AddiereGanzzahlen()). Ob Sie ihren Programmcode in Englisch oder Deutsch programmieren, ist jedem selbst überlassen. Unsere Beispiele haben wir bewusst auf Deutsch programmiert. Selbstverständlich sollten Sie auch in jeder Zeile immer nur eine Anweisung oder Deklaration notieren. Zwischen Schlüsselwörtern und Klammern oder Kommas sollte des Weiteren unbedingt jeweils ein Leerzeichen notiert werden. Zudem empfiehlt es sich for-Schleifen bei Arrays durch foreach-Schleifen zu ersetzen, falls dies möglich ist.
Wie wir in C# Kommentare notieren haben wir ja bereits im Grundlagen-Kapitel gelernt. Eine gute Kommentierung ist sehr wichtig, sodass wir auch noch nach ein paar Jahren unseren Programmcode nachvollziehen können. Doch zusätzlich zu diesen „normalen“ Kommentaren ermöglicht es Visual Studio eine Dokumentation für Klassen, Funktionen und Eigenschaften anzulegen. Hierfür notieren wir drei Schrägstriche. Dadurch erstellt Visual Studio automatisch ein Dokumentations-Gerüst, welches unten beispielhaft aufgeführt ist. Die Dokumentation wird in der IntelliSense-Autovervollständigung angezeigt.

Program.cs

using System;

namespace CSV20.Namensregeln_Kommentierung
{
    /// <summary>
    /// Klasse des Hauptprogramms, welches die Main()-Funktion enthält.
    /// </summary>
    class Program
    {
        /// <summary>
        /// Der Haupteinstiegspunkt der Konsolen-Anwendung.
        /// </summary>
        /// <param name="args">Die Parameter, welche dem Programm beim Start übergeben wurden.</param>
        static void Main(string[] args)
        {
            Console.WriteLine(Addieren(6195, 153));

            Console.ReadKey();
        }

        /// <summary>
        /// Addiert 2 ganzzahlige 32bit Werte (vorzeichenbehaftet) miteinander.
        /// </summary>
        /// <param name="iZahl1">Die 1. Zahl welche für die Rechnung benötigt wird.</param>
        /// <param name="iZahl2">Die 2. Zahl welche für die Rechnung benötigt wird.</param>
        /// <returns>Das Ergebnis der Addition beider übergebener Zahlen.</returns>
        static int Addieren(int iZahl1, int iZahl2)
        {
            return iZahl1 + iZahl2;
        }
    }
}
Download

LinksRechts