2013-08-10 7 views
0

Мне нужно создать комментарий XML для возвращаемого значения метода Login. Этот метод возвращает тип объекта результата. Этот объект содержит идентификатор сеанса, если логин был успешным, и если логин был неудачным, появляется сообщение об ошибке.Правильные комментарии XML для возвращаемого значения общего метода

Я не знаю, как decribe это в комментарии XML.

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

Благодарим за советы.

ответ

2

Вы могли бы использовать:

/// ... 
/// This method returns an object of type <see cref="Result{Account}"/>. 
/// ... 

См cref Attribute.

+0

Благодарим за быстрый ответ. – imodin