6

Sto cercando di utilizzare i tag <see cref=""> nei tag di documentazione XML per la mia API, ma vengono visualizzati vuoti nelle pagine della Guida.I tag della documentazione XML non vengono gestiti dalle pagine della guida dell'API Web 2?

Così, per una descrizione mi piacerebbe che a dire: "Ottiene o imposta il valore per l'associato voce"

Dove L'articolo è un collegamento a un altro oggetto nell'API.

Invece, sto ottenendo:

"Ottiene o imposta il valore per l'associato".

Quindi il tagviene ignorato. Ho anche provato ad utilizzare esempi da here nel caso in cui la mia dichiarazione fosse errata, ma non ha funzionato neanche.

Qualcun altro ha avuto problemi con questo? A che livello sono supportati i tag della documentazione XML nelle nuove pagine della Guida all'API Web 2? Qualcuno sa se è possibile aggiungere il supporto manualmente, se no?

+0

Abbiamo lo stesso problema, ma tutti i post del blog su questo argomento sembravano obsoleti. – Remy

+0

Descrivo un modo per farlo a http://stackoverflow.com/questions/26177104/asp-web-api-help-pages-links-to-other-pages/26255631#26255631 –

risposta

0

non ho avuto problemi con questo, ma vi suggerisco

  • Posta un semplice esempio che illustra il comportamento, insieme con il risultato che si ottiene

  • Verificare la presenza di avvertenze di compilazione che potrebbero indicare problemi con i tag della documentazione XML.

Ad esempio, si dice che si sta utilizzando <see cref=""> stai mettendo un identificativo valido l'attributo CREF e la chiusura del tag sede - per esempio <see cref="MyClass.MyMethod" />?

+0

Hey Joe, abbiamo lo stesso problema e sembra che anche altre persone lo vedano. In caso di suggerimenti su dove iniziare? – Remy