XML-Kommentare in Visual Studio aktualisieren

  • Allgemein

Es gibt 5 Antworten in diesem Thema. Der letzte Beitrag () ist von rwCapt.

    XML-Kommentare in Visual Studio aktualisieren

    Einen schönen guten Abend zusammen,
    in den Header-Dateien meiner derzeitigen Projektmappe kommentiere ich immer fleißig die Klassen- und Funktionsdeklarationen mit den XML-Tags:

    XML-Quellcode

    1. ///<summary>Das ist eine Zusammenfassung!</summary>


    Das klappt auch soweit so gut bis zu einem bestimmten Punkt. Ich habe das Gefühl, dass die Anzeige der Zusammenfassungen in diesem Popup-Fenster ab einer bestimmten Komplexität der Projektdateien fehlerhaft oder gar nicht mehr eingelesen werden.



    Kann es sein, dass irgendwo in der Projektmappe eine Datei hinterlegt wird, die irgendwas mit den Kommentaren zutun hat und irgendwann nicht mehr hinterher kommt?

    Sehe ich das richtig? Ist das C++ / CLI.

    Scheint mir ein komischer Effekt zu sein. Deine XML-Kommentare sind sowieso nicht vollständig, denn deine Methode setRectangle(parameter) besitzt auch noch ein Parameter. Ich weiss nur nicht, ob es eventuell sogar daran liegen könnte.

    Um XML-Kommentare zu erstelle verwende gleich oberhalb der Methode 3 mal Slash >> "///". Es wird dir ein Gerüst vorgeschlagen das übernommen werden kann. FUNKST NICHT IN CLI

    In jeder DotNet-Anwendung können die XML-Kommentare als Datei ausgelagert werden. Dazu gibt es einen Schalter in den Eigenschaften wo auch die Auslagerungsdatei angeben werden kann.


    Freundliche Grüsse

    exc-jdbi

    Dieser Beitrag wurde bereits 3 mal editiert, zuletzt von „exc-jdbi“ ()

    Ja, die Vorschläge nutze ich eigentlich immer. Dreimal Slash und man kann lostippen. Ich habe herausgefunden, dass es wohl ausreicht, den unsichtbaren ".vs"-Ordner zu löschen. Welche Datei(en) nun genau an diesem Dokumentationscache beteiligt sind, versuche ich nochmal herauszufinden.

    Es handelt sich nicht um C++/CLI, sondern um einen eigenen Versuch, Win32-Funktionen zu kapseln. Nach dem Muster wie man es aus C#/C++CLI kennt.

    Was wird da im ersten Bild das </summary> grün gekringelt unterstrichen? Was hat VS da auszusetzen?
    Dieser Beitrag wurde bereits 5 mal editiert, zuletzt von „VaporiZed“, mal wieder aus Grammatikgründen.

    Aufgrund spontaner Selbsteintrübung sind all meine Glaskugeln beim Hersteller. Lasst mich daher bitte nicht den Spekulatiusbackmodus wechseln.

    Hallo @rwCapt

    Ich hätte noch einen Vorschlag für die XML-Kommentare. Also bei meiner CLI Version funkst es, vielleicht hast du Glück und es funkst auch bei dir.

    Ich könnte mir schon vorstellen, dass das ein Grund dafür sein könnte, warum es bei dir alles verschoben hat.
    Aber sicher bin ich mir nicht. Infos habe ich von hier. Ist halt CLI.
    docs.microsoft.com/de-de/cpp/b…-visual-cpp?view=msvc-160
    docs.microsoft.com/de-de/cpp/b…ments-c-cpp?view=msvc-160


    C-Quellcode

    1. /// <summary>
    2. /// Irgend Ein Text
    3. /// </summary>
    4. /// <param name="rectangle">Parameter</param>
    5. /// <returns>Rückgabewert</returns>

    Das Return-Tags natürlich nur, wenn es auch einen Rückgabewert gibt

    Freundliche Grüsse

    exc-jdbi

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „exc-jdbi“ ()

    @VaporiZed
    Gute Frage :D
    IntelliSense sagt mir, ihm fehle die Definition einer anderen Member-Funktion. Dabei existiert diese in der cpp-Datei und außerdem ist die Deklaration in einer ganz anderen Zeile, in der ich den grünen Kringel da viel eher hin packen würde. Ja, in der Datei ist/war irgendwie alles etwas verschoben. Mich würde interessieren, was den Cache da so durcheinander bringt.

    @exc-jdbi Danke für die Links, da stehen noch einige relevante Infos drin.