Vsdocman
VSdocman |
 | |
| 개발자 | 헬릭스소프트 |
|---|---|
| 안정된 릴리스 | 2021년 12월 16일 / 11.0 ( |
| 운영 체제 | 창문들 |
| 유형 | 문서 생성기 |
| 면허증. | 독자 사양 |
| 웹 사이트 | https://www.helixoft.com |
VSdocman은 코드 코멘트와 C# 및 VB로부터의 기술 문서의 자동 생성을 가능하게 하는 문서 생성기입니다.NET 프로젝트확장으로 Visual Studio에 직접 통합됩니다.
개요
VSdocman은 Visual Studio 2022, 2019 및 2017의 확장판입니다.문서 컴파일러와 주석 편집기의 두 가지 주요 부분으로 구성됩니다.컴파일러는 다양한 형식으로 최종 클래스 문서를 작성합니다.주석 편집기는 [1]컴파일러가 사용하는 XML 주석을 반자동으로 삽입 또는 편집하기 위한 도구를 제공합니다.
문서 컴파일러
VSdocman은 사용자 설정에 따라 Visual Studio 프로젝트의 코드를 스캔하고 문서를 자동으로 만듭니다.이 작업은 VS UI 또는 명령줄(예: 자동 빌드)에서 직접 수행할 수 있습니다.이 문서는 목차, 인덱스, API 클래스 문서 및 커스텀 토픽, 상호 참조, 검색, IntelliSense 및 F1 컨텍스트 의존 [2]도움말과 함께 MSDN 스타일을 따릅니다.
컴파일러는 Visual Studio 프로젝트에 액세스할 수 있으므로 설명서에 소스 코드 및 클래스 다이어그램(.cd 파일)을 포함할 수도 있습니다.프로젝트를 개별적으로 문서화할 수도 있고 솔루션 전체에 대한 [3]단일 문서를 생성할 수도 있습니다.
출력 문서의 형식은 구성할 수 있습니다.정의된 형식은 다음과 같습니다.
출력은 현지화할 수 있으며 일부 언어는 [4]이미 포함되어 있습니다.
코멘트 에디터
VSdocman은 소스 코드로부터 XML 코멘트를 읽을 수 있습니다.코멘트를 수동으로 편집하는 것은 어려운 작업일 수 있습니다.따라서 WYSIWYG 코멘트 에디터가 포함되어 XML 코멘트 및 커스텀토픽을 기술하는데 도움이 됩니다.테이블, 목록, 그림, 클래스 다이어그램, 링크 및 기타 형식을 소스 코드에 직접 삽입할 수 있습니다.코드 멤버유형에 따라 사용자는 기본 코멘트를 지정할 수 있습니다.이 코멘트는 사용자가 처음 코멘트를 추가하거나 편집할 때 자동으로 추가됩니다.예를 들어 "Boolean [5]특성에 대해 요약 텍스트가 자동으로 생성되는지 여부를 나타내는 값을 가져오거나 설정합니다.
역사
원래 VSdocman의 이름은 VBdocman이었습니다.VBdocman에서 진화했기 때문에 NET.VBdocman.NET은 Visual Basic만 지원했습니다.NET.[6] 2006년 C# 지원을 추가한 후 VSdocman으로 이름이 변경되었습니다.
「 」를 참조해 주세요.
레퍼런스
외부 링크
