Wie markiert man, dass eine Klasse Thread-sicher ist (oder nicht)?

Question

In MSDN-Dokumentation sehen wir:

Console

Thema Sicherheit

Diese Art Thread-sicher ist.

TextWriter

Thema Sicherheit

Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Alle Instanzmitglieder sind nicht garantiert Thread sicher sein.

Ich habe eine ähnliche (statische) Klasse wie die Console one entwickelt, also wie kann ich sie mit Thread-Safe markieren? Ich extrahiere XML-Dokumentation, und ich würde wissen, wie ich diesen Teil im MSDN Doc machen kann.

Hoffe, dass ich klar genug bin ...

Dank für die Hilfe!

Answer 1

Fügen Sie dieses Detail zu den Tags <summary> oder <remarks> hinzu.

Es gibt kein spezielles Tag oder eine bestimmte Konvention, um anzugeben, dass eine Klasse threadsicher ist - Sie müssen sie in Ihre Dokumentation schreiben.

Answer 2

Das Sandcastle Help File Builder Projekt enthält eine nützliche XML Comments Guide.

Es documents the threadsafety tag:

<threadsafety static="true|false" instance="true|false"/> 

Die Wurzel SHFB Dokumentationsseite ist here.