¿Cómo etiquetar que una clase es segura para subprocesos (o no)?

Question

En la documentación de MSDN vemos:

Console

Seguridad para subprocesos

Este tipo es seguro para subprocesos.

TextWriter

hilo de seguridad

Cualquier públicas estáticas (Shared en Visual Basic) de este tipo son seguros para subprocesos. No se garantiza que ningún miembro de instancia sea seguro para subprocesos.

He desarrollado una clase similar (estática) a la consola, entonces, ¿cómo puedo etiquetarla para que sea segura? Estoy extrayendo documentación XML y sabría cómo puedo esta parte en el documento MSDN Doc '.

Esperanza Soy lo suficientemente clara ...

Gracias por la ayuda!

Answer 1

Agregue este detalle a las etiquetas <summary> o <remarks>.

No hay una etiqueta o convención específica sobre cómo indicar que una clase es segura para subprocesos; debe escribirla en su documentación.

Answer 2

El proyecto Sandcastle Help File Builder contiene un útil XML Comments Guide.

Se documents the threadsafety tag:

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

La página de documentación SHFB raíz es here.