Visual Studio 프로젝트에 개발자 설명서를 추가하는 가장 좋은 방법
기본적으로 질문은 다음과 같습니다.Visual Studio 프로젝트와 관련된 텍스트 개발자 문서를 어디에(어떤 형식으로) 저장해야 합니까?
자세히 설명하자면, XML 주석은 훌륭하지만 모든 사용 사례를 포함하지는 않습니다.때로는 프로젝트의 클래스 아키텍처를 높은 수준으로 설명하거나, 라이브러리에 사용 노트를 추가하거나, 이 프로젝트에서 작업하는 미래 세대의 개발자에게 다른 종류의 메시지를 남기고 싶을 수도 있습니다.
이 문서들을 Visual Studio 프로젝트에 직접 파일로 추가하여 (a) 개발자가 추가 검색 없이 사용할 수 있도록 하고, (b) 버전 제어(소스 코드와 동일한 svn/git/임의 저장소 사용)하고 싶습니다.
현재 폴더를 추가합니다._Documentation텍스트 파일을 사용하여 프로젝트에 적용할 수 있지만, 이것이 최선의 해결책인지는 잘 모르겠습니다.Visual Studio에는 자동으로 텍스트를1 줄 바꿈하는 옵션이 없으므로 변경할 때마다 줄 바꿈을 수동으로 수정하는 것이 번거롭습니다.반면에 Word 문서는 버전 제어와 잘 작동하지 않으며 TeX는 각 개발자 PC에서 설정하고 가르치는 것이 너무 번거롭습니다.
이를 위한 잘 확립된 모범 사례가 있습니까?
1 Edit/Advanced/Word-Wrap(편집/고급/Word-Wrap)이 있다는 것은 알고 있지만, 이는 표시에만 영향을 미치며 파일 자체에는 영향을 주지 않습니다.
저도 방금 같은 문제가 있었습니다. HTML 파일을 추가할 수 있다는 것을 알게 되었습니다.열리면 화면 하단의 "설계"로 전환합니다.빌드 작업을 '내용'에서 '없음'으로 변경할 수 있습니다.
하드코딩된 HTML 문서이므로 인라인 그림(예: 다이어그램)을 사용할 수도 있습니다.
또한 저의 목적(프로그래밍 가이드, 아키텍처 설명, 데이터베이스 사용 예제)을 위해 별도의 프로젝트를 만들기로 결정했습니다._Documentation)를 Windows Forms(윈도우 폼)로 사용하면 실행 예제를 사용할 수 있습니다.
클래스, 메서드, 속성 등을 추가할 때 프로젝트 문서화를 위해 GhostDoc(시각 스튜디오 추가 기능)을 사용합니다. http://visualstudiogallery.msdn.microsoft.com/46A20578-F0D5-4B1E-B55D-F001A6345748
XML 주석에 Sandcastle(사이트)과 같은 도구로 수집하여 실제 MSDN 스타일 참조 사이트로 전환할 수 있는 많은 데이터를 포함하는 옵션이 있습니다.
나는 이 방법을 사용하는 경향이 있고 단지 긴 XML 주석(MSDN 주석 태그)을 사용합니다(해당되는 경우).<para></para>문단을 생성하고 향후 수식어/개발자에게 필요한 패턴, 비즈니스 이유 또는 구조 정보를 설명합니다.저는 또한 그것을 사용 예시를 제공하는 데 사용합니다.
좋은 테스트 배치(잘 작성되고 이름이 지정됨)는 코드의 목적을 실제로 밝혀줄 수 있으며, 사양 역할을 합니다.
저는 그것이 당신의 연구에 약간의 정보가 되기를 바랍니다 :)
XML 주석은 특정 방법을 문서화하는 데 가장 적합하며 긴 개념적 내용을 작성하는 데 이상적이지 않습니다.XML 주석이 길면 코드 가독성에 악영향을 미칠 수 있습니다.
Sandcastle의 개념 주제 문서화 기능이 마음에 들었고, 기능적이든 아키텍처와 관련된 개념 문서화를 생성 및 저장하고 코드 문서(XML 주석)와 병합할 수 있습니다.개념적 주제를 작성할 때 사용할 수 있는 마크업은 확장 가능하므로 엔터프라이즈 템플릿도 준수할 수 있습니다.
언급URL : https://stackoverflow.com/questions/9735623/best-way-to-add-developer-documentation-to-your-visual-studio-projects
'source' 카테고리의 다른 글
| xxx'의 구독이 클라우드 'AzureCloud'에 없습니다. (0) | 2023.05.24 |
|---|---|
| 외부에서 도커 컨테이너의 Postgresql에 연결 (0) | 2023.05.24 |
| json_decode()를 사용하여 개체 대신 배열을 만듭니다. (0) | 2023.05.24 |
| Xcode에서 기존/미사용 데이터 모델 버전을 삭제하는 방법 (0) | 2023.05.24 |
| MongoDB에서 여러 필드에서 여러 값 검색 (0) | 2023.05.24 |