Ich habe eine Reihe von C# -Code geerbt. Für einige Methodendefinitionen finde ich ///<exclude/> als das einzige XMLDoc davor. Ich habe versucht, die Bedeutung von Google zu googeln, war aber nicht erfolgreich. Kann jemand bitte erklären, was das bedeuten könnte?Was bedeutet "/// <exclude/>"?
Zumindest in NDoc bedeutet dies, dass die XML-Dokumentation für dieses Mitglied ausgeschlossen werden sollte. Vom documentation:
Der
<exclude/>Tag leitet NDoc das aktuelle Element aus Dokumentation auszuschließen.
Es ist mir nicht klar, ob dies war ursprünglich NDoc spezifisch, aber es ist auch von Sandcastle unterstützt zu sein scheint (in, dass es in den Sandcastle XML comments guide ist).
Vom Sandcastle Help File Builderdocumentation:
ist ein Namespace über die Namespace Zusammenfassungen Eigenschaft ausgeschlossen oder Artikel ausgeschlossen, weil seine XML-Kommentare enthalten ein < ausschließen/> Tag. Diese Informationen werden automatisch mit den Einstellungen des API-Filters zusammengeführt. Um diese Elemente zu ändern, müssen Sie die Namespace- Summaries-Eigenschaft verwenden oder das Tag aus den XML-Kommentaren des Elements entfernen.
Eine offizielle Antwort:
A way to exclude documentation?
und weitere Informationen über das Verhalten:
Danke für Ihre Antwort. – Andreas
@Hanky 웃 Panky: diese Frage zu beantworten: Es Jon Skeet (Periode)! ;-) – Andreas
Ich habe keine Beweise, dass dieses Projekt NDoc verwendet. Vielleicht hat jemand in der Vergangenheit versucht, NDoc zu verwenden. Wenn es keine andere bekannte Verwendung dieser Sache gibt, nehme ich Jons Antwort. Vielen Dank! – Andreas