2014-04-07 4 views
1

많은 강력한 형식의 데이터 집합이 포함 된 프로젝트가 있습니다.자동으로 생성 된 .designer.cs 파일을 문서화하는 방법?

일부 XML 주석을 추가해야하지만 그래픽 DataSet 편집기에서 사소한 변경 만 수행하면 첨부 된 .designer.cs 파일을 다시 생성하여 이전에 편집 한 주석을 제거합니다. 모든 자동 생성 된 클래스는 내가 수동으로 편집 .cs 안에 모든 문서와 파일을 추가 한 부분이기 때문에

/// <summary> 
///After opening tag... 
///The text is attached to the slashes, 
///causing doxygen to put the enclosing tag into doc 
///</summary> 

: 자동으로 생성 된 코드 주석 게다가

가난한 형식을 가지고있다. 이것은 클래스 선언에 대해서는 꽤 잘 작동하지만, 속성과 메소드는 어떻게 될까요?

누구나 강력한 형식의 데이터 집합을 문서화하는 더 좋은 전략을 알고 있습니까?

답변

-1

Microsoft는 설명서 용 기본 제공 도구를 제공합니다. 당신은 프로젝트 메뉴, 속성을 클릭에, VBA 프로젝트 솔루션 탐색기에서 프로젝트를 선택으로

  1. 에 대한 XML 문서 파일을 생성하려면 다음 단계

    하여 문서를 생성 할 수 있습니다.

  2. 컴파일 탭을 클릭하십시오.
  3. 컴파일 페이지에서 XML 문서 생성 파일을 선택하십시오. 기본적으로 파일은 지정된 출력 경로 ( 예 : "bin \ Debug \ Projectname.XML") 아래에 만들어집니다.

은 프로젝트 메뉴에서 클릭하고 속성을 Visual C# 프로젝트 솔루션 탐색기에서 프로젝트를 선택으로

  1. 에 대한 XML 문서 파일을 생성합니다.
  2. 빌드 탭을 클릭하십시오.
  3. 빌드 페이지에서 XML 문서 파일을 선택하십시오. 기본적으로 파일은 지정된 출력 경로 아래에 생성됩니다 (예 : "bin \ Debug \ Projectname.XML").

GhostDoc을 살펴 보시기 바랍니다. 최신 Visual Studio를위한 놀라운 플러그인. http://submain.com/products/ghostdoc.aspx XML 문서를 자동으로 생성합니다. 물론 다른 사람들은 좋아하는 것을 가지고 있습니다.

+0

GhostDoc은 훌륭하고 전문적인 도구로 보입니다. 그러나 Visual Studio 2005에 맞았습니다. Visual Studio 유전자 코드 문서화 방법을 알고 있습니다. 필자는 자동으로 생성 된 파일에 코드 설명서를 올바르게 배치하는 방법에 대해 궁금합니다. – sblandin

관련 문제