How to tag that a class is thread-safe (or not)?

Question

In MSDN documentation we see :

Console

Thread Safety

This type is thread safe.

TextWriter

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

I've developed a similar (static) class to the Console one, so how can I tag it to thread safe? I'm extracting XML documentation and I would know how I can this part like in the MSDN Doc'.

Hope I'm clear enough...

Thanks for help !

Answer 1

Add this detail to the <summary> or <remarks> tags.

There is no specific tag or convention on how to indicate a class is thread safe - you need to write it in your documentation.

Answer 2

The Sandcastle Help File Builder project contains a useful XML Comments Guide.

It documents the threadsafety tag:

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

The root SHFB documentation page is here.