如何标记类是线程安全的(或不是)？

Question

在MSDN文档中,我们看到:

安慰

线程安全

这种类型是线程安全的.

的TextWriter

线程安全

此类型的任何公共静态(在Visual Basic中为Shared)成员都是线程安全的.任何实例成员都不保证是线程安全的.

我已经为Console一个开发了一个类似的(静态)类,那么如何将它标记为线程安全呢？我正在提取XML文档,我知道我可以像MSDN Doc那样使用这个部分.

希望我足够清楚......

感谢帮助 !

Answer 1

在沙堡帮助文件生成项目包含一个有用的XML注释指南.

它记录了threadsafety标签:

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

根SHFB文档页面在这里.

Answer 2

将此详细信息添加到<summary>或<remarks>标记.

没有关于如何指示类是线程安全的特定标记或约定 - 您需要在文档中编写它.