Los prefijos de referencia en .NET documentación XML

Question

He estado tratando de documentar completamente todos los tipos, métodos, propiedades, etc., de una biblioteca de clases utilizando los comentarios XML, pero se han topado con un curioso efecto que implica el atributo cref (utilizado por las etiquetas see por ejemplo). A juzgar por el consejo de esta página de MSDN , así como después de varios otros ejemplos de MSDN y otros sitios web, parece que cada vez que uno especifica un valor de referencia usando la etiqueta cref, debe ser precedido de un determinado marcador que clasifica el refence (como 'T:' para el tipo y 'M:' para el método) .

El uso de Microsoft Castillo de arena, sin embargo, he observado que, a falta de estos prefijos hay un efecto en la documentación generada (archivo de ayuda CHM en este caso). Incluyendo prefijos (en todas las situaciones I belive), la referencia se hace en la página de texto en negrita ... Sin embargo discluding el prefijo de la referencia se representa como un ancla (link) a la página apropiada dentro de la referencia de la API. Parece bastante extraño que el método recomendado de prefijar (todos?) Referencias está dando el resultado menos útiles - ¿por qué la referencia se representa como negrita en un caso y en otro vinculado? Le agradecería si alguien podría arrojar alguna luz sobre esto.

Answer 1

Esto parece haber sido un bug en el castillo de arena

¿Qué versión de castillos de arena está usando?

discusiones recientes parecen indicar que, al menos para este tipo de sistema, el método sugerido es evitar usar realmente los nombres cualificados ya los ejemplos planteados en esa respuesta se redujo el T: y M:. Su confusión del todo, por lo tanto no es inesperado o poco común

Esta documentación implica fuertemente que el compilador, donde puede lugar qué tipo / método / constante que esté apuntando a inserta los prefijos para usted. ¿Ha verificado esto en el xml?