Code Comments

Kódírás közben gyorsan megszokja, hogy nagyjából minden beírt karakternek vagy szónak különleges jelentése van. Például sok kulcsszót lát a C # -ben, például class, namespace, public és még sok más . Azt is látni fogja, hogy a fordító megbizonyosodik arról, hogy ezeket a kulcsszavakat, valamint a saját változóit és módszereit a megfelelő módon használja. A C # egy meglehetősen szigorú nyelv, és a fordító segít abban, hogy minden a megfelelő módon legyen megadva. A megjegyzések koncepciójának köszönhetően azonban egyetlen lehetősége van arra, hogy bármit írjon, amit szeretne.

Lehet, hogy már tapasztaltál megjegyzéseket néhány kódban, legyen az C # vagy bármely más programozási nyelv - a megjegyzések fogalma a kódban meglehetősen általános. Írásmódjuk azonban nagyon változik, ezért nézzük meg, milyen típusú megjegyzéseket használhat a C # kódjában.

Egy soros megjegyzések

A legalapvetőbb megjegyzés típus a C#-ban az egysoros megjegyzés. Ahogy a nevéből adódik, egyetlen sort megjegyzéssé változtat. Nézzük meg hogy néz ki:

// My comments about the class name could go here...
class Program
{
    ......

So that's it: Prefix your lines with two forward slashes (//) and your text goes from something the compiler will check and complain about, to something the compiler completely ignores. And while this only applies to the prefixed line, you are free to do the same on the next line, essentially using single-line comments to make multiple comment lines:

// My comments about the class name could go here...
// Add as many lines as you would like
// ...Seriously!
class Program
{
    ...... 

Több-soros kommentek

Abban az esetben hogyha akarsz több soros megjegyzéseket írni, több értelme lenne használni a több-soros megjegyzés formáját amit C# ajánl. Minden vonal előtti sor kiírás helyett, csak megadsz egy kezdés és megálló karakter sorrendet - minden ami a közte van az megjegyzésként fogja kezelni.

/*  
My comments about the class name could go here...  
Add as many lines of comments as you want  
    ...and use indentation, if you want to!  
*/  
class Program  
{
    ......

Használd az kezdés sorrendet ami a előre-per-csillag (/*), írj amit szeretnél, több soron keresztül vagy sem, és utána zárd le mindent a záró sorrendel ami a *-előre-per (*/). A jelölő között azt írhatsz amit akarsz.

As with pretty much any other programming related subject, whether to use multiple single-line comments or one multi-line comment is often debated. Personally, I use both, for various situations - in the end, it's all up to you!

Dokumentáció kommentek

Documentation Comments (sometimes referred to as XML Documentation Comments) looks like regular comments, but with embedded XML. Just like with regular comments, they come in two forms: Single-line and multi-line. You also write them the same way, but with an extra character. So, single-line XML Documentation Comments uses three forward slashes (///) instead of two, and the multi-line variant gets an extra asterisk added in the start delimiter. Let's see how it looks:

class User
{
    /// <summary>
    /// The Name of the User.
    /// </summary>
    public string Name { get; set; }

    /**
    * <summary>The Age of the User.</summary>
    */
    public string Age { get; set; }
}

Here you can see both variants - single-line and multi-line. The result is the same, but the first variant tends to be the most commonly used for documentation comments.

Documenting your types and their members with documentation comments is a pretty big subject, and therefore it will be covered more in depth in a later article, but now you know how they look!

Kód megjegyzések és a Feladat lista

If you're using Visual Studio, you can actually get some help tracking your code comments. In the Task List window (access it from the menu View > Task List) your comments will appear if they use the special, but very simple Task List comment syntax:

//TODO: Change "world" to "universe"
Console.WriteLine("Hello, world!");
//HACK: Don't try this at home....
int answerToLife = 42;

So if the single-line comment is immediately followed by TODO or HACK, it will appear in the Task List of Visual Studio, like this:

And there are more types - depending on the version of Visual Studio you're using, it will respond to some or all of the following comment tokens:

• TODO - teendő
• HACK
• NOTE - jegyzet
• UNDONE

You can even add your own tokens, if you want to - just follow the steps described in this article.

Summary

Code comments are extremely useful in documenting your code or for the purpose of leaving clues to your self or your potential colleagues on how stuff works. As an added benefit, they're great when you need to test something quickly - just copy a line and comment out the original line and you can see how it works now. If you're not happy with the result, you can just delete the new line and uncomment the original line and you're back to where you started.

And don't worry about the end-user snooping through your comments - they are, as already mentioned, completely ignored by the compiler and therefore not in anyway included in your final DLL or EXE file. Code comments are your personal free-space when programming, so use it in any way you want to.