2009-09-11 3 views
2

모든 .cs 파일을 검사하고 "코드 주석 적용 범위"에 대해 다시보고 할 Visual Studio 2008 추가 기능 또는 매크로를 찾고 있습니다. 우리 회사의 표준은 모든 C# 클래스, 메서드 및 속성에 코드 주석이 달려 있다는 것입니다. 나는 커다란 해결책을 가지고 있으며, 손으로 파일을 검토하는 것은 많은 시간을 낭비한다. 어떤 파일에 코드 주석이 있고 어떤 파일에 코드 주석이 없는지 정확히 알려주는 보고서가 있다면 그 파일 만 검사 할 수 있습니다.코드 주석에 대한 Visual Studio 파일 확인

나는 이것을 달성하기위한 코드를 작성하는 데 신경 쓰지 만, 나는 바퀴를 재발 명하고 싶지 않습니다. 이 기능을 수행하는 추가 기능이나 매크로가 있습니까? 실패한 경우, 리플렉션 또는 System.CodeDom 네임 스페이스를 사용하여 클래스의 코드 주석을 확인하는 방법이 있습니까? 클래스를 객체 모델에로드 할 수만 있다면 나머지 부분을 얻을 수 있습니다.

답변

5

StyleCop 클래스 및 클래스 멤버에 대한 XML 문서를 확인합니다.

+0

현재 내 빌드 출력의 대부분은 StyleCop 경고입니다. 좋은 소식/내가 추측하는 나쁜 소식 :-). – DaveE

+0

감사합니다. dtb. 이것은 즉각적인 필요를 해결합니다. 그럼에도 불구하고, 나는 녹색 라이트/레드 라이트/노랑 라이트 코드 코멘트 커버리지 VS 애드 인을 만드는 방법을 살펴볼 것입니다. – virsum

5

프로젝트 빌드 설정에서 XML documentation 출력을 활성화 한 다음 "모든 경고를 오류로 사용"하십시오. 문서화되지 않은 클래스와 비공개 또는 내부가 아닌 멤버에 대해서는 오류가 발생합니다.

Visual Studio 용 Ghost Doc 확장 프로그램은 여기서 타이핑 작업을 줄이는 데 유용하며 무료입니다.

Sandcastle Help File Builder은 모든 문서 작업을 멋진 HTML, CHM 또는 HxS 파일로 전환하는 가장 쉬운 방법입니다.

마지막으로 멋진 점은 설명서에 예제로 포함될 reference code regions 일 수 있습니다. 단위 테스트를 문서로 재활용하고 샘플이 정확한지 확인하십시오 : 돌 하나 두 마리! :-)