2013-08-10 7 views
0

메서드 Login의 반환 값에 XML 주석을 작성해야합니다. 이 메서드는 Result의 객체 유형 을 반환합니다. 로그인에 성공한 경우이 객체에는 세션 ID가 포함되며 로그인에 실패하면 오류 메시지가 포함됩니다.일반 메서드의 반환 값에 대한 XML 설명을 수정하십시오.

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