Wie kann ich die Dokumentation einer Klasse in einer anderen Klasse lesen?

Question

Nehmen wir an, ich habe Klasse A und Klasse B. Die Definition von Klasse A ist

/// <summary>
/// This is the class documentation.
/// </summary>
public class A
{
    /// <summary>
    /// This is the documentation for attribute.
    /// </summary>
    public int attribute;
    ...
}

Ich möchte auf die Dokumentation der Klasse A (d.h. die Strings, die lauten "Dies ist die Klassendokumentation." und "Dies ist die Dokumentation für das Attribut.") in Klasse B programmatisch zugreifen. Gibt es eine Möglichkeit, dies zu tun? vielleicht mit Reflexion?

Vielen Dank für Ihre Hilfe :)

Answer 1

Ich gehe davon aus, dass Sie Visual Studio verwenden. Gehen Sie zu den Projekteinstellungen und legen Sie den Pfad für die Xml-Dokumentationsdatei fest. Wenn Sie kompilieren, werden die Kommentare in eine Xml-Datei ausgegeben. Sie können dann die Datei programmatisch öffnen und die Kommentare lesen

Answer 2

Die Dokumentation wird nicht in die Programmbaugruppen exportiert. Sie wird (optional) in separate XML-Dateien extrahiert.

Um das zu tun, was Sie vorschlagen, müssten Sie ein Tool finden oder schreiben, das die XML-Dateien analysiert und Metadaten in die Baugruppe einfügt, oder die XML-Datei mit der Baugruppe ausliefern und in sie eintauchen, wenn Sie die zugehörige Dokumentation abrufen möchten.

Answer 3

Erzeugen Sie die XML-Dokumentationsdatei, die Sie dann programmatisch analysieren können.