Ho questo metodo che sto cercando di generare documentazione.Come utilizzare IEnumerable <String> nel codice di documentazione
/// <summary>
/// This method demonstrates taking a Func as argument and perform that action(Func) on a list of strings.</summary>
/// <param name="listOfStrings"> ... </param>
/// <param name="ActionToPerformOnEach"> ... </param>
/// <returns>Returns an <see cref="IEnumerable{String}" /> which has elements that resulted due to the Func action </returns>
public static IEnumerable<String> ActOnListWithFunc(List<string> listOfStrings, Func<string, string> ActionToPerformOnEach) {
foreach (string s in listOfStrings) {
string actedString = ActionToPerformOnEach(s);
yield return actedString;
}
}
Questo genera la documentazione come questo (solo Valore restituito è mostrato sezione)
Return Value
Type: IEnumerable<String>
Returns an IEnumerable<T> which has elements that resulted due to the Func action
Dove sto descrivendo il valore di ritorno del metodo, voglio usare IEnumerable <stringa> ma se si guarda la desscription che sta generando IEnumerable T >. Il Digitare: (seconda riga sopra) sebbene sia stato prelevato correttamente come IEnumerable <stringa>. Solo la riga descrittiva per il valore restituito non è corretta.
Come descriviamo IEnumerable <stringa> o IEnumerable <int> o di qualsiasi altro tipo specifico di censimento nel descrizioni di parametri o valori restituiti, ovvero betwween <param> </param > o <rendimenti> </restituisce > tag del metodo in fase di documentazione.
possibile duplicato di [Come fare riferimento a classi e metodi generici nella documentazione xml] (http://stackoverflow.com/questions/532166/how-to -reference-generic-classes-and-methods-in-xml-documentation) –
Sto già usando nell'attributo Returns per il metodo, ma non mostra il tipo generico specifico (stringa). Si prega di consultare la terza riga della seconda patch di codice pubblicata. Si legge IEnumerable invece di IEnumerable –
Jatin