Selektive XML-Dokumentationsdatei für (DLL-) Projekt

  • C#

Es gibt 2 Antworten in diesem Thema. Der letzte Beitrag () ist von RodFromGermany.

    Selektive XML-Dokumentationsdatei für (DLL-) Projekt

    Moin Leute.
    In den Projekt-Eigenschaften kann man einstellen, dass das Projekt eine XML-Dokumentationsdatei erstellt.
    Alle Variablen, Properties, Methoden, Events, Delegates kann man dann mit einem /// bzw. ''' kommentieren und alle diese Kommentare landen dann in der XML-Dokumentationsdatei des Projekts.
    Diese Kommentare werden HOver-Event angezeigt, wenn die Maus über einem dokumentierten Befehl ... steht (IntelliSense-Funktion).

    C#-Quellcode

    1. /// <summary>
    2. /// This class does something.
    3. /// </summary>
    4. public class SomeClass
    5. {
    7. }

    VB.NET-Quellcode

    1. ''' <summary>
    2. ''' This class does something.
    3. ''' </summary>
    4. Public Class SomeClass
    5. {
    7. }

    Soweit alles fein.
    Nun kommentiere ich auch interne und private Prozeduren usw. Diese Kommentare benötige ich zur Arbeit an meinem Projekt.
    Wenn nun die DLL mit dieser XML-Dokumentations-Datei beim Kunden ankommt, stehen da eben auch die Kommentare zu den privaten Prozeduren usw. drin, die den Kunden jedoch nix angehen.
    Frage:
    Gibt es einen Trick (einen nicht veröffentlichten Microsoft Befehl oder so), mit dem ich dem Projekt sagen kann, dass in der Release die XML-Kommentare zu den Nicht-Public-Prozeduren nicht enthalten sein sollen?
    Oder muss ich die von Hand aus der XML-Datei entfernen?
    Freundlichen Dank schon mal.
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    Hallo

    Da ich Dokus händisch erstelle weis ich es jetzt leider keinen direkten weg für sowas aber....

    RodFromGermany schrieb:

    dass in der Release die XML-Kommentare zu den Nicht-Public-Prozeduren nicht enthalten sein sollen?

    Wenn es nur im Release nicht drinnen sein soll dann:

    VB.NET-Quellcode

    1. #If DEBUG Then
    2. ''' <summary>
    3. ''' Foo
    4. ''' </summary>
    5. #End If
    6. Public Sub New()
    8. End Sub


    Vieleicht hilft es dir trotzdem. :/

    Grüße
    Sascha
    If _work = worktype.hard Then Me.Drink(Coffee)
    Seht euch auch meine Tutorialreihe <WPF Lernen/> an oder abonniert meinen YouTube Kanal.

    ## Bitte markiere einen Thread als "Erledigt" wenn deine Frage beantwortet wurde. ##

    @Nofear23m Elementar einfach, allerdings etwas mühselig.
    Funktioniert.
    Danke.
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

Facebook
Telefonspende