C# public Methoden aus der Dokumentation ausschliessen

OP #3195636
Hi,

wenn ich mit VisualStudio ein Dokufile im XML Format generiere, möchte 
ich gerne, dass gewisse Methoden, die zwar public sind, ausschliessen.
Geht das irgendwie?

Also es geht explizit um ein Projekt für eine MetroApp und ich habe ne 
Liste mit 80 Warnings, die sich alle aber auf die 
Auto-Generated-Teil-Klassen beziehen.
Gast #3195801
"exclude" aus der sandcastle-doku:
1
/// <summary>
2
/// This method will not appear in the help file even though it is public.
3
/// </summary>
4
/// <exclude />
5
public void UndocumentedMethod()
6
{
7
}

Der Eintrag taucht in der *.xml weiterhin auf, aber zusätzlich auch ein 
"exclude"-Node, den einige Tools (z.B. sandcastle und ndoc) beachten.

Wenn die Datei nicht weiterverarbeitet wird oder durch ein Tool, das 
exclude nicht kennt und sonst auch keine Filter-Möglichkeit bietet:
Da würde ich vermutlich einfach selbst schnell ein Tool basteln das die 
entsprechenden Nodes einfach rauslöscht und das Tool an den 
Build-Vorgang dran hängen.
OP #3195849
Hi, das ist schon die Lösung, ja, aber das Problem ist, das die 
Teilklasse die Automatisch generiert wurde von VisualStudio überwacht 
wird. Sobald ich da ein Zeichen reinschreibe, überschreibt VisualStudio 
im Hintergrund die Datei und bittet mich darum, diese neu zu laden...

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 13 Jahre alt. Stell sie in einem eigenen Thread – dort lesen mehr Leute mit, und sie wird öfter und schneller beantwortet.

Neuen Thread starten

Eine Lösung, Ergänzung oder Rückmeldung zu diesem Thread? Dann antworte hier.

Formatierung
  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] – Link zu einem Artikel
  • Verweis auf einen anderen Beitrag: Rechtsklick auf dessen Beitrags-ID (#8078628), „Adresse kopieren“, in den Text einfügen

Mehr zur Formatierung

Längeren Sourcecode als Anhang, nicht in den Text. JPG nur für Fotos und Scans; Zeichnungen und Screenshots als PNG oder GIF. Siehe Bildformate.

Schon registriert? Anmelden

Wird nicht angezeigt. Wir schicken dir einen Link; sobald du damit bestätigst, erscheint dein Beitrag.

Mit dem Abschicken legst du einen kostenlosen Account an und erkennst die Nutzungsbedingungen und die Datenschutzerklärung an.