C# 更正泛型方法返回值的XML注释
我需要为方法Login的返回值创建XML注释。此方法返回对象类型 当然是结果。如果登录成功,则此对象包含会话id;如果登录失败,则此对象包含错误消息 我不知道如何在XML注释中描述这一点C# 更正泛型方法返回值的XML注释,c#,xml-comments,generic-method,C#,Xml Comments,Generic Method,我需要为方法Login的返回值创建XML注释。此方法返回对象类型 当然是结果。如果登录成功,则此对象包含会话id;如果登录失败,则此对象包含错误消息 我不知道如何在XML注释中描述这一点 /// <summary> /// Login to server /// </summary> /// <param name="name">Name of user</param> /// <param name="password">User p
/// <summary>
/// Login to server
/// </summary>
/// <param name="name">Name of user</param>
/// <param name="password">User password</param>
/// <returns>
/// This method return object type of Result<Account>
/// If login was successful contains sessions
/// If login was unsuccessful contains error
/// </returns>
Result<Account> Login(string name, string password);
/// <summary>
/// Return value of method
/// </summary>
/// <typeparam name="T">Type of return value</typeparam>
public class Result<T>
{
/// <summary>
/// Return message
/// </summary>
public string ResultMessage { get; set; }
/// <summary>
/// Return value
/// </summary>
public T ReturnValue { get; set; }
}
public class Account
{
public string Name{get;set;}
public string Password {get;set;}
public string Session {get;set;
}
//
///登录到服务器
///
///用户名称
///用户密码
///
///此方法返回结果的对象类型
///如果登录成功,则包含会话
///如果登录不成功,则包含错误
///
结果登录(字符串名称、字符串密码);
///
///方法的返回值
///
///返回值的类型
公开课成绩
{
///
///回信
///
公共字符串ResultMessage{get;set;}
///
///返回值
///
公共T返回值{get;set;}
}
公共类帐户
{
公共字符串名称{get;set;}
公共字符串密码{get;set;}
公共字符串会话{get;set;
}
谢谢您的建议。您可以使用:
/// ...
/// This method returns an object of type <see cref="Result{Account}"/>.
/// ...
//。。。
///此方法返回类型为的对象。
/// ...
请参阅。您将使用:
/// ...
/// This method returns an object of type <see cref="Result{Account}"/>.
/// ...
//。。。
///此方法返回类型为的对象。
/// ...
请参阅。谢谢您的快速回答。谢谢您的快速回答。