Как отметить, что класс является поточно-ориентированным (или нет)?

Question

В документации MSDN мы видим:

Консоль

Безопасность потоков

Этот тип является поточно-ориентированным.

TextWriter

Thread Safety

Любые открытые статические (Shared в Visual Basic) члены этого типа являются потокобезопасными.Любые члены экземпляра не гарантируют поточно-ориентированную защиту.

Я разработал (статический) класс, аналогичный классу Console, так как я могу пометить его как поточно-ориентированный?Я извлекаю документацию по XML, и я бы знал, как это сделать, как в MSDN Doc '.

Надеюсь, я достаточно ясен ...

Спасибо за помощь!

Answer 1

Конструктор файлов справки Sandcastle содержит полезное Руководство по XML-комментариям .

Он документирует тег threadsafety :

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

Корневая страница документации SHFB: здесь .

Answer 2

Добавьте эту деталь к тегам <summary> или <remarks>.

Нет конкретного тега или соглашения о том, как указать, что класс является потоком.безопасно - вам нужно записать это в своей документации.