Func<T1,T2,....> 参数的某些部分是否可以为智能感知提供 xml 注释？

Question

所以，我有一个接受回调并执行它的操作。看起来有点像这样。有什么我可以填写到问号区域（或其他地方）以记录进入 APICall Func 参数的参数的详细信息吗？

/// <summary>
/// Opens Authenticated session to servers using ClientSide SDK's, performs action, closes session
/// </summary>
/// <typeparam name="T">The object to be returned from the authenticated action</typeparam>
/// <param name="credentials">Container for username, password</param>
/// <param name="APICall">?????????????????</param>
///
/// ?????????????????????
/// ?????????????????????
/// ?????????????????????
///    
/// <returns>T</returns>
private static T MakeAuthenticatedCall<T> (CredStorage Credentials, Func<string,T> APICALL)
{
   AuthenticationManager.Login(Credentials);
   T APIResult = APICall(AuthenticationManager.SessionID);
   AuthenticationManager.LogOff();

   return APIResult;
}

Answer 1

您可以定义自己的委托来执行此操作，而不是使用内置的 Func<T,...> 委托。

那你不仅可以给它XML文档，你还可以给参数起一个更具描述性的名字。

例如：

/// <summary>Makes an API call.</summary>
/// <typeparam name="T">The type returned by the API call.</typeparam>
/// <param name="param">The parameter passed to the API call.</param>
/// <returns>The value returned by the API call.</returns>

public delegate T ApiCall<T>(string param);

然后你会在你的方法中使用它而不是 Func<string,T>:

private static T MakeAuthenticatedCall<T>(CredStorage Credentials, ApiCall<T> APICALL)
{

这可以说是一种更好的方法，尽管代价是必须花费额外的时间来定义一个特殊的委托。

Func<T1,T2,....> 参数的某些部分是否可以为智能感知提供 xml 注释？

Can portions of the Func<T1,T2,....> parameter be given xml comments for intellisense?

c#

delegates

comments

xml-comments