코드에 클래스 설명 추가?

Question

는 내가 잠시 동안 작업 해 온 프로젝트를 마무리하고있어, 그냥 마지막 손질에 걸었습니다.

내가하고 싶은 것은 각 클래스 파일의 맨 위에 클래스 설명을 추가하는 것입니다 (자신과 다른 프로그래머가 무슨 일이 일어나는지 파악할 수 있도록). 내 생각은 단지 '/'의 묶음을 사용하여 섹션을 밧줄로 묶어서 메모를 작성하는 것이지만 더 좋은 방법이있을 수 있습니까? Visual Studio에서이 작업을 수행 할 수있는 방법이 있습니까?

///////////////////////////////////////////////////// 
//             // 
// KillZombies.cs         // 
//             // 
// Description: This class contains blah blah blah // 
//             // 
///////////////////////////////////////////////////// 

Answer 1

예, 일반 XML documentation 사용해야합니다

/// <summary> 
/// Describe your class quickly here. 
/// </summary> 
/// <remarks> 
/// Add more details here. 
/// </remarks> 

는 인텔리에 표시됩니다, 당신은 샌드캐슬/ndoc 사용하여 문서를 만들 경우/Doxygen을이 적절하게 나타날 것 등 그 방법을. 당신이 입력하면

는 "///"클래스 위의 라인에, 당신은 적절한 템플릿을 시작하는 볼 수 있습니다. 자세한 내용은 위의 MSDN 링크를 참조하십시오.

Answer 2

사용 XML documentation comments : 당신은 세 가지 시각 슬래시를 입력하면

/// <summary> 
/// This class performs an important function. 
/// </summary> 

스튜디오 나머지 당신을 도울 것입니다.

멋진 ASCII 형식을 사용하지 마십시오. 나이를 들여 보낼 클래스 이름을 리팩터링하여 다시 정렬 할 때 모든 상자를 다시 포맷하기 때문에 사용하지 마십시오. 답변에 설명

Answer 3

은 XML 문서 주석 위 클래스와 메소드의 문서에 갈 수있는 방법입니다.

작성일, 크레디트, 저작권 메시지 등과 같이 문서 이외의 텍스트에 대한 각 파일의 추가 정보가 필요하면 스 니펫으로 추가하거나 적절한 Visual Studio 템플릿에 추가 할 수 있습니다. VS에는 $ username $ 및 $ time $과 같은 템플릿에 대한 특수 변수가 있으며 템플릿을 기반으로 새 항목을 추가 할 때마다이 값을 자동으로 삽입하는 데 사용할 수 있습니다.