VS-Tipps & Tricks: Kommentare intelligent und einfach umbrechen

 Wer programmiert, der dokumentiert auch. Denke ich zumindest 😀

Ich zumindest habe teilweise Kommentare, die sich über 10 bis zu 100 Zeilen erstrecken. Die sind nah am Code und erklären, oft was die Hintergründe für das gewählte Design und Vorgehen sind.

Leider ist aber der Editor vom Visual Studio kein Word. D.h. absatzweisen Umbruch kennt das Ding nicht und manuell solche Texte inkl. Einrückungen und Listen mit Bindestrichen oder 1., 2., 3. zu formatieren ist etwas was gar keinen Spaß macht. Zudem sind die Kommentar Zeichen // oder * eher lästig als hilfreich beim schreiben.
Und auch VAX muss hier mal passen. Aber! Netterweise gibt e auch andere Addins.

Ich habe vor langer Zeit schon den Comment Reflower  entdeckt. Mit dem ist das Ganze ein Klacks.
Aus dem nachfolgenden Text:

// Dies ist ein Kommentar, den man nicht wirklich hier schreiben
// müsste und der
// eigentlich nichts bedeutet außer
// die Funktionen von einem netten Addin zu zeigen.
// Das
//  1. wirklich Arbeit erspart
//  2. total simpel zu bedienen ist
//  3. für alle VS-Versionen von 2005 über 2008 bis 2010 verfügbar ist.
// Was bei der Formatierung heraus kommt lässt sich sehen.

Wird in Null-Komma-Nichts der folgende Text:

// Dies ist ein Kommentar, den man nicht wirklich hier
// schreiben müsste und der eigentlich nichts bedeutet
// außer die Funktionen von einem netten Addin zu
// zeigen. Das
//  1. wirklich Arbeit erspart
//  2. total simpel zu bedienen ist
//  3. für alle VS-Versionen von 2005 über 2008 bis
//     2010 verfügbar ist.
// Was bei der Formatierung heraus kommt lässt sich
// sehen.

Wer noch mehr Beispiele sehen will, was das Tool leistet findet hier auf der Sourceforge Seite ein Vorher Nacher Pärchen.

Das Addin existiert für alles Visual Studio Versionen ab 2005.
Es kann hier heruntergeladen werden:

PS: Es empfiehlt sich ein Blick auf die Blockdefnition in den Einstellungen. Dort ist oft ein Leerzeichen hinter dem * bzw. // eingetragen. Leider lässt sich in meiner Version hier RegEx nicht einschalten. Wer also ein <tab>-Zeichen hinter dem * oder // hat wird sich wundern wenn das Addin keinen Kommentar findet. Ich habe das Leerzeichen einfach entfernt…

PPS: Für alle nicht C++ Entwickler. Das Tool funktioniert auch für VB und C# ❗

2 Gedanken zu „VS-Tipps & Tricks: Kommentare intelligent und einfach umbrechen“

  1. Hallo,

    ich bekomme immer

    —————————
    No comment found
    —————————
    OK
    —————————

    Was kann das sein? Das ist der Kommentar:

    /************************************************************************
    kasf hsaködfh söakdh saköj ghsköa ghsköafjgh asköf ghsfköagh sfköal ghsföakjg hasfö jhsfaög hasdfök jhfg
    ä faglasj fglökasfj glökasdfjg löakd fjglöakfj glöfkajglökafjglöka fdjgklöa fgja
    ************************************************************************/
  2. Bitte kontrolliere mal die Einstellungen. Am Ende in meinem Artikel habe ich im PS darauf hingewiesen.
    Wie ds Addin einen Kommentar Block erkennt steht in den Regeln!
    Die müssen schon passen.
    Ein Block Comment muss in diesem Beispiel mit einem * beginnen.
    Wenn Du es also so machst:

    /************************************************************************
     * kasf hsaködfh söakdh saköj ghsköa ghsköafjgh asköf ghsfköagh sfköal ghsföakjg hasfö jhsfaög hasdfök jhfg
     * ä faglasj fglökasfj glökasdfjg löakd fjglöakfj glöfkajglökafjglöka fdjgklöa fgja
    ************************************************************************/
    

    Wird das daraus:

    /************************************************************************
     * kasf hsaködfh söakdh saköj ghsköa ghsköafjgh asköf ghsfköagh sfköal
     * ghsföakjg hasfö jhsfaög hasdfök jhfg ä faglasj fglökasfj glökasdfjg löakd
     * fjglöakfj glöfkajglökafjglöka fdjgklöa fgja
    ************************************************************************/
    

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert

I accept that my given data and my IP address is sent to a server in the USA only for the purpose of spam prevention through the Akismet program.More information on Akismet and GDPR.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.