Forum: PC-Programmierung C# public Methoden aus der Dokumentation ausschliessen


von Mike M. (mikeii)


Lesenswert?

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.

von bluppdidupp (Gast)


Lesenswert?

"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.

von Mike M. (mikeii)


Lesenswert?

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...

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.