Main 메소드를 문서화하는 방법은 무엇입니까?

Question

자, 이제 .NET 콘솔 응용 프로그램이 Main 메서드이고 Program 클래스에 들어 있습니다. 당신은 평소 알고

내가 너무 엄격하게 StyleCop와의 FxCop을 사용하기 시작했습니다 이후

class Program 
{ 
    static void Main(string[] args) 
    { 
     // Do something spectactular 
    } 
} 

, 나는 알 - 피키 제대로 문서화되어 있는지 모든 것을 만드는 약의 종류가 될했습니다.

그럼 나를 때렸다. 나는 을 절대적으로 가지고있다. 프로그램과 프로그램을 올바르게 문서화하는 방법을 모른다.

난 당신이 다음과 같이 갈 수 있음을, 장기적으로, 가정 :

/// <summary> 
///  Encapsulates the application's main entry point. 
/// </summary> 
class Program 
{ 
    /// <summary> 
    ///  The application's main entry point. 
    /// </summary> 
    static void Main(string[] args) 
    { 
     // Do something spectactular 
    } 
} 

을하지만 그건 (내 홈페이지 루틴은 항상 작업을 할 다른 클래스에 위임한다는 사실에도 불구하고) 부적당 한 비참하게 보인다 .

어떻게 이러한 것들을 문서화합니까? 권장 사항이나 표준이 있습니까?

Answer 1

"내 생각 엔 응용 프로그램의 주요 진입 점"이라고 말하면서 주요 기능을 문서화하는 것은 가치가 없습니다. 누군가 Main이 응용 프로그램의 주 진입 점이라는 것을 모르는 경우에는 코드 근처에서 원하는 부분을 원하지 않습니다.

거기에 무엇이든 입력하면 예상되거나 받아 들인 인수가 무엇인지 문서화 할 수 있습니다 ,하지만 정보가 개발자뿐만 아니라 소프트웨어 사용자들에게도 유용하기 때문에 프로그램 옵션 (예 : 사용법을 인쇄하는 사용 기능, 사용자 설명서, 추가 정보 파일 또는 다른 곳)을 문서화 할 수있는 좋은 곳이 있다고 생각합니다. .

Answer 2

콘솔 프로그램 이 실제로의 용도를 설명하는 클래스 수준에서 설명서를 추가하므로 용도가 다릅니다.

Main 메소드에서 필요한 인수 등을 문서화하십시오. 'main entry point'로 지정하지 않으면 예외가됩니다.

Run(string[] args)이라는 프로그램의 인스턴스 메서드에 전달하는 경향이 있으므로이 경우에는 인수/스위치 옵션을 사용하여 Run 메서드를 문서화하십시오.

Program prog = new Program(); 
prog.Run(args);

Answer 3

그냥하지,하지 마십시오 :

는

내 main() 메소드의 몸은 단순히처럼 보인다. 작성한 두 개의 샘플을보고 어느 것이 더 판독 가능합니까?

댓글없이 하나를 선택하겠습니다.

Answer 4

문서에서 코드에서 명확하지 않은 것을 추가 할 수 있습니다. 그리고 도구는 문서화해야 할 것과하지 말아야 할 것을 당신에게 지시하는 것이 아니라 당신을 도울 것입니다.

"응용 프로그램의 주요 진입 점"은 아무 것도 추가하지 않으므로 쓰지 마십시오.

매개 변수와 같이 명백하지 않은 것이 있으면 문서화하십시오.