如何在记录代码中使用IEnumerable <String>

Question

我有这个方法,我试图生成文档.

    /// <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;
        }
    }

这会生成这样的文档(仅显示返回值部分)

Return Value
Type: IEnumerable<String>
Returns an IEnumerable<T> which has elements that resulted due to the Func action

在我描述方法的返回值的地方,我想使用IEnumerable <string>但是如果你看一下desscription它就会生成IEnumerable <T>.的类型:(上面第二行),虽然是被正确拾取作为IEnumerable的<字符串>.只是返回值的描述行不正确.

我们如何在参数或返回值的描述中描述IEnumerable <string>或IEnumerable <int>或任何其他特定类型的枚举,即在方法的<param> </ param>或<returns> </ returns>标记之间被记录.

Answer 1

您可以使用显示相应的文本<see cref="IEnumerable{String}">IEnumerable&lt;string&gt;</see>.但是,链接仍将是,IEnumerable<T>因为没有具体的文档IEnumerable<string>