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

前端 未结 2 761
傲寒
傲寒 2021-02-07 00:59

In MSDN documentation we see :

Console

Thread Safety

This type is thread safe.

TextWriter

Thread Safet

相关标签:
2条回答
  • 2021-02-07 01:22

    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.

    0 讨论(0)
  • 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.

    0 讨论(0)
提交回复
热议问题