Pergunta

Eu estive tentando documentar completamente todos os tipos, métodos, propriedades, etc, de uma biblioteca de classe usando comentários XML, mas ter executado em um curioso efeito envolvendo o atributo cref (usado por tags see por exemplo). Indo pelo conselho de desta página MSDN , bem como após vários outros exemplos no MSDN e outros sítios, parece que quando a pessoa especifica um valor de referência, utilizando o tag cref, ele deve ser precedido por um determinado marcador que classifica o refence (tais como 'T:' para o tipo e 'M:' para o método) .

Usando o Microsoft Sandcastle, no entanto, tenho observado que, perdendo esses prefixos há um efeito na documentação gerada (arquivo de ajuda CHM, neste caso). Incluindo prefixos (em todas as situações, eu acredito), a referência é processado na página como texto em negrito ... No entanto, discluding o prefixo a referência é processado como uma âncora (link) para a página apropriada dentro da referência da API. Parece um pouco estranho para mim que o método recomendado de prefixo (todos?) Referências está dando o resultado menos útil - por que a referência ser processado como negrito em um caso e ligada em outro? Agradecia que se alguém poderia lançar alguma luz sobre isso.

Foi útil?

Solução

Esta parece ter sido um bug no castelo de areia

Qual versão do castelo de areia que você está usando?

Dito discussões recentes parecem indicar que, pelo menos, para os tipos de sistema, o método sugerido é realmente evitar o uso de nomes qualificados desde os exemplos postuladas em que a resposta deixou cair o T: e M:. inteiramente sua confusão não é, portanto, inesperada ou incomum

Esta documentação implica fortemente que o compilador, onde ele pode detectar que tipo / método / constante que você está apontando para inserções os prefixos para você. Você verificou isso no xml?

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top