2013-03-20 3 views
2

그래서 난 것처럼 내가 그들을 문서화 어떻게 내가이여러 변수가있는 선언을 위해 "XML doc"을 작성하는 방법은 무엇입니까?

double 
     TempAngle = 1, 
     AngleCountDown = HalfSight, 
     SightAngleFromCopter = 0; 

같은 조각을 가지고 말할 수에 simmilar 변수를 매니하는 방법을 점점 상당히 큰 C# 프로젝트에서 작업 방법 (아래 참조)? 내가하고 싶은 whould 무엇 결국

/// <summary> 
    /// general explanation 
    /// </summary> 
    /// <param name="a">some hole num</param> 
    /// <param name="b">some string</param> 
    public MainWindow(int a ,string b) 
    {} 

당신은 것입니다에만 작동이 이상이

/// <summary> 
/// general explanation for TempAngle 
/// </summary>  
double TempAngle = 1; 

/// <summary> 
/// general explanation for AngleCountDown 
/// </summary> 
double AngleCountDown = HalfSight; 

/// <summary> 
/// general explanation for sightanglefromcopter 
/// </summary> 
double SightAngleFromCopter = 0; 

더 많은처럼 각 변수에 대해 작성해야

/// <param name="TempAngle">some</param> 
    /// <param name="AngleCountDown">something</param> 
    /// <param name="SightAngleFromCopter">something else</param> 
    double 
     TempAngle = 1, 
     AngleCountDown = HalfSight, 
     SightAngleFromCopter = 0; 
+2

xml 주석이 필요하지 않습니다. –

+0

변수 이름을 포함하여 코드가 명확하면 코드를 문서화 할 필요가 없습니다. –

+1

코드가 무엇인지 확실하지 않은 커다란 코드 기반을 가지고 있다면, 이는 리팩터링 할 시간임을 나타내는 특정 기호입니다. 코드를 정리하고 특정 용도로 사용되는 작고 명확하고 잘 정의 된 클래스로 분리하십시오. –

답변

4

같은 것을 작성하는 것입니다 클래스 수준 변수의 경우 및 메서드 수준 변수의 경우가 아닙니다.

+0

이것이 유일한 방법 일까? –

+0

예. 그 유일한 방법. –

+0

그냥 엉망, 추악하고 부 풀리는 느낌. 그것은 가능한 것처럼 느껴집니다. –