C# Comments

In dit artikel leren we over C# comments, verschillende stijlen van comments, en waarom en hoe u ze effectief in een programma gebruikt.

Comments zijn het bloed van leesbare code. Ze zijn door mensen leesbare aantekeningen die intentie uitleggen, complexe logica verduidelijken en ontwerpbeslissingen documenteren. De compiler negeert ze volledig, dus ze beïnvloeden de runtime-prestaties niet.

Volgens Microsoft's officiële documentatie ondersteunt C# drie primaire commentstijlen:

1. Single-Line Comments (//)
2. Multi-Line Comments (/* */)
3. XML Documentatie Comments (///)

Single-Line Comments

Single-line comments beginnen met een dubbele slash // en lopen tot het einde van de regel. Alles wat volgt op // wordt door de compiler genegeerd.

int a = 5 + 7; // 5 en 7 optellen

Hier is 5 en 7 optellen de comment.

Voorbeeld 1: Een Single-Line Comment Gebruiken

// Hello World Program
using System;
namespace HelloWorld {
    class Program {
        public static void Main(string[] args) // Uitvoering begint bij Main methode
        {
            // Print Hello World
            Console.WriteLine("Hello World!");
        }
    }
}

Het bovenstaande programma bevat drie single-line comments:

// Hello World Program
// Uitvoering begint bij Main methode
// Print Hello World

Hoewel u een comment op dezelfde regel als code kunt plaatsen, is best practice om comments op aparte regels te houden om rommel te voorkomen.

Multi-Line Comments

Multi-line comments beginnen met /* en eindigen met */. Ze kunnen meerdere regels beslaan, ideaal voor blok-uitleg of tijdelijk uitschakelen van codeblokken.

Voorbeeld 2: Een Multi-Line Comment Gebruiken

/* Dit is een Hello World Program in C#.
   Dit programma print Hello World. */
using System;
namespace HelloWorld {
    class Program {
        public static void Main(string[] args) {
            /* Print Hello World */
            Console.WriteLine("Hello World!");
        }
    }
}

Het programma bevat twee multi-line comments:

/* Dit is een Hello World Program in C#. Dit programma print Hello World. */
/* Print Hello World */

Let op dat een enkel /* … */ blok een single-line comment kan vervangen wanneer beknoptheid gewenst is.

XML Documentatie Comments

XML documentatie comments beginnen met drie slashes /// en staan ontwikkelaars toe om gestructureerde metadata direct in code in te sluiten. Deze comments worden door tools zoals Visual Studio geëxtraheerd om externe XML documentatiebestanden te genereren, die door IDE's gebruikt kunnen worden voor IntelliSense tooltips en door documentatiegeneratoren.

Als u nieuw bent met XML, zie Wat is XML?.

Voorbeeld 3: Een XML Documentatie Comment Gebruiken

/// <summary>
/// Dit is een hello world programma.
/// </summary>
using System;
namespace HelloWorld {
    class Program {
        public static void Main(string[] args) {
            Console.WriteLine("Hello World!");
        }
    }
}

De XML comment in het voorbeeld is:

/// <summary>
/// Dit is een hello world programma.
/// </summary>

Het gegenereerde XML bestand zou er als volgt uitzien:

<?xml version="1.0"?>
<doc>
<assembly>
<name>HelloWorld</name>
</assembly>
<members>
</members>
</doc>

Voor diepere inzichten, bezoek XML Documentation Comments.

Comments Op de Juiste Manieren Gebruiken

Effectieve comments verduidelijken intentie zonder de code te verwarren. Over-commenteren kan de logica verbergen, terwijl onder-commenteren onderhoud bemoeilijkt.

Bekijk dit voorbeeld:

// Print Hello World
Console.WriteLine("Hello World");

Een comment toevoegen is hier redundant; de code is zelfverklarend. Gebruik comments in plaats daarvan om:

• Niet-voor-de-hand-liggende algoritmen of businesslogica uit te leggen.
• Aannames, edge cases of potentiële vallen te benadrukken.
• Kort het doel van een blok te beschrijven, gericht op het "waarom" in plaats van het "hoe".

Onthoud: beknopte, doelgerichte comments zijn een kenmerk van professionele codebases.