Domanda

Sono stato cercando di documentare pienamente tutti i tipi, metodi, proprietà, ecc di una libreria di classi utilizzando i commenti XML, ma hanno incontrato un curioso effetto che coinvolge l'attributo cref (usato da tag see per esempio). Andando per consiglio di questa pagina MSDN così come segue vari altri esempi su MSDN e altri siti, sembra che ogni volta che si specifica un valore di riferimento utilizzando il tag cref, deve essere preceduto da un certo indicatore che classifica il refence (ad esempio 'T:' per il tipo e 'M:' per il metodo) .

Con Microsoft Castello di sabbia, però, ho osservato che, perdendo questi prefissi c'è un effetto nella documentazione prodotta (CHM file di aiuto in questo caso). Compresi i prefissi (in tutte le situazioni I belive), il riferimento è reso sulla pagina di testo in grassetto ... Eppure discluding il prefisso il riferimento è reso come un'ancora (link) alla pagina appropriata all'interno del riferimento API. Sembra piuttosto strano che il metodo suggerito di prefisso (tutti?) I riferimenti sta dando il risultato meno utile - perché dovrebbe il riferimento essere reso in grassetto in un caso e collegato in un altro? Gradirei se qualcuno potesse far luce su questo.

È stato utile?

Soluzione

Questo sembra essere stato un bug nel castello di sabbia

Quale versione di castello di sabbia stai usando?

recenti discussioni sembrano indicare che, almeno per i tipi di sistema, il metodo suggerito è quello di evitare in realtà utilizzando i nomi qualificati in quanto gli esempi postulato in quella risposta è sceso il T: e M:. interamente la vostra confusione non è dunque inaspettato o non comuni

Questa documentazione implica fortemente che il compilatore, dove può posto che tipo / metodo / costante si sta indicando inserisce i prefissi per voi. Hai verificato questo nel xml?

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top