Microsoft .NET 어셈블리 문서의 작성 및 관리의 자동화
Microsoft .NET 어셈블리 문서의 작성 및 관리를 자동화할 수 있습니다. Document! X를 사용하여 컴포넌트, 응용 프로그램 및 데이터 베이스용의 종합적이고 정확한 전문문서 세트를 자동적으로 Web에 공개할 수 있는 상태로 작성하는 것이 가능합니다. 컴파일하여 목차, 색인, 완전한 텍스트 서치 기능이 부가된 HTML헬프 또는 헬프 2.0파일로 작성하는 것도 가능합니다. V3의 새로운 기능으로는 헬프 2.0제공, C# XML코멘트 파일의 구성 , Visual Studio.NET 의 다이나믹 헬프 제공, 데이터 베이스 문서 (T-SQL코드의 +Tagged Comments), 개선된 VB 코멘트 헬퍼 애드인이 있습니다.
버전 3.0의 새로운 기능 :
Document! X 3.0 에서는 .NET어셈블리와 데이터 베이스 구조의 문서 작성 및 그 외의 폭 넓은 일반적인 강화 기능이 도입되었습니다.
.NET 제공 :Document! X에서는 .NET어셈블리 문서를 작성할 수 있게 되었습니다. 문서 스타일은 Microsoft .NET Framework 문서에 바탕을 두고 있으며, .NET 개발자에게 익숙하게 되어 있습니다. 생성되는 문서에서는 Namespaces, Classes, Structures, Enumerations, Methods, Properties, Fields, Events, Delegates 등, 모든 .Net 요소가 가능합니다. Document! X Commenter 는 어셈블리의 Document! X Comment파일 작성에 사용할 수 있습니다. C# XML코멘트 파일 (소스 코드의 XML 코멘트에서 C#컴파일러가 생성)은 가능한 장소에서 사용됩니다.
생성되는 컨텐츠에는 다음과 같은 것이 들어있습니다.
- Microsoft .Net 문서의 외관과 분위기.
- 완전한 목차와 인덱스.
- 클래스 계승 트리.
- 객체 관계도.
- 개요와 멤버를 정리한 페이지.
- 팝업의「관련항목」박스와 「언어」박스.
- 구성문과 코멘트 타입 참조의 완전한 하이퍼링크.
- Visual Studio.Net 언어 필터를 제공하는 Visual Basic과 C# 의 구성문.
- 「SeeAlso」참조와 「See」참조를 포함한 기존 C# 코멘트 파일의 종합
- Help 2.0 컴파일 제공.
- Visual Studio.Net 다이나믹 종합 헬프를 자동적으로 제공하는 파일 작성.
- .NET Support 의 완전한 개요는 토픽「Microsoft .NET Support Overview」에 있습니다.
데이터 베이스 문서 : 이번 릴리스에서는 데이터 베이스의 문서화가 제공되고 있습니다. 생성되는 문서에서는 표, 관계 (외부 키), 인덱스, 뷰, 스트어드 브로셔 및 트리거* 가 가능합니다. (* SQL Server데이터 베이스로 한정). 제공되고 있는 데이터 베이스는 Access (Jet), SQL Server, 제공되고 있는 ADO접속식 문자열에 따라 ADO 준하고 있는 그 외의 데이터 베이스입니다.
생성되는 컨텐츠로는 다음과 같은 것이 들어있습니다.
- 현대적이고 전문성이 풍부한 문서의 외관과 분위기.
- 색상이 있는 T-SQL / DDL 소스 코드.
- 플라이머리 키의 멤버쉽, 데이터 타입, 크기, NULL가능성을 나타내는 예에 관한 표.
- 관계 (외부 키) ID.
- 관련항목에 대한 링크를 제공하는 멤버 개요에 관한 표.
- 스트어드 순서의 파라메이트.
- 스트어드 순서의 트리거, 뷰 (SQL Server만) 에서 탭 코멘트를 취득.
- 기존의 설명 속성을 취득 (SQL Server만).
- 조합 문서 : 복수 템플릿으로 문서 작성이 가능하기 때문에 , 예를 들면 컴포넌트와 데이터 베이스로 하나의 통합된 문서 세트를 배포할 수 있습니다.
단순한 코멘트 타입 : 텝 코멘트 타입이 간단하게 되었습니다. (레거시 타입의 문서화는 완전하게 제공). 모든 ##.._DESCRIPTION 타입은 ##SUMMARY 로, ##.._REMARKS 는 ##REMARKS 로, ##_SEE_ALSO 는 ##SEEALSO 로, ##.._EXAMPLE 는 ##EXAMPLE로 변환되었습니다. 인터페이스와 변수 코멘트에서는 수식자가 필요 없습니다. Commentator! X 에서는 이러한 변경이 자동적으로 관리됩니다. (새로운 코멘트와 수정 코멘트는 자동적으로 업그레이드됩니다).
페이지 레이아웃 설계 : Page Layout에디터에는 대폭 개선된 [Insert Element] 다이얼로그가 조합되었습니다. 이러한 새로운 다이얼로그에서는 편집하고 있는 페이지 레이아웃의 관련 요소만 표시됩니다. 변수나 탭 코멘트 등의 항목을 삽입하면 관련 항목만 제공되기 때문에 페이지 레이아웃의 설계와 확인이 간단하게 됩니다.
Help 2.0 제공 :Document! X에서는 새로운 Help 2.0표준이 제공됩니다. 이것은 HTML Help의 변환 포맷입니다.
재 설계된 아키텍처 : 새로운 항목 타입을 더 많이 제공하기 위하여 Document! X 의 기초가 되는 엔진이 PlugIn 아키텍처에 준하여 설계되었습니다. 따라서 이제부터 릴리스에서 항목 타입을 더욱 간단하게 제공할 수 있게 되었습니다.
Document! X 에서는 VB프로젝트, 컴파일이 끝난 COM 컴퍼넌트 (dll, ocx), 타입 라이브러리의 프로 품질의 컨테스트 의존 HTMLHelp 나 기술 문서의 작성과 저장이 자동화됩니다. Document! X 에서는 정확하게 저장이 편한 문서를 생성할 수 있으며, 분석과 설계에서부터 제공과 저장까지 개발 프로세스의 모든 단계가 제공됩니다.
Document! X기능의 개요
완전한 문서 솔루션
- Microsoft .Net Assembies, Visual Basic / VBA 소스, 컴파일 완료된 COM (ActiveX) 컴포넌트, 타입라이브러리, 데이터 베이스를 하나의 툴로 문서화할 수 있습니다.
- 코드, 컴포넌트, 데이터베이스의 단일 통합 문서 세트를 생성할 수 있습니다.
- Visual Basic 애드인 (Commentator! X)으로 Visual Basic / VBA 소스 코드의 작성과 관리를 실행합니다. 통합 HTML 에디터와 「관련 항목」링크 designerU가 구성되어 있습니다.
- .Net 어셈블리의 문서화에서는 기존의 C#코멘트 파일을 사용할 수 있습니다. 계승 멤버 (.Net 프레임워크 어셈블리로부터 계승된 멤버 등) 의 기존 설명을 사용할 수 있습니다.
컨텍스트 헬프와 Visual Studio.NET다이나믹 헬프의 통합
- .Net 어셈블리 : 생성된 문서를 Visual Studio.NET 다이나믹 헬프 시스템으로 통합하기 위하여 필요한 파일이 생성됩니다. Visual Studio.NET 의 사용자는 문서화가 완료된 어셈블리에 대한 코팅을 할 때 관련 문서 토픽에 바로 엑세스가 가능합니다.
- VB 소스 : 필요한 모든 헬프 컨텍스트 ID 의 생성과 상호 링크가 실행되며, 컨텍스트 헬프가 제공됩니다. (사용자가 컴포넌트를 사용해서 코딩하고 있는 경우, 또는 객체 브라우저를 탐색하고 있는 경우에 F1 키를 누르면 토픽이 표시됩니다).
- VB소스 : 컴포넌트에 컴파일되며, 사용자가 객체 브라우저를 사용해서 컴포넌트를 표시할 때 표시되는 헬프 설명이 생성됩니다. Visual Basic の [Procedure Attributes]다이얼로그를 사용할 필요가 없습니다.
- COM 컴포넌트 : 컴포넌트 멤버에 할당된 기존의 컨텍스트 ID 를 사용해서 생성된 문서로 링크할 수 있습니다.
객체 모델도
- 완전한 계층 그래픽컬 관계도가 각각 모듈로 생성됩니다.
- 프로젝트의 상호 관계를 인식할 수 있습니다.
- 필요한 경우에 특정 관계를 무시할 수 있습니다. (모 객체와의 관계 등).
- 커렉션 객체는 자동적으로 인식되며 적절하게 표현됩니다.
- 객체 모델의 루트 클래스를 명확하게 식별하고 논리적으로 바른 개요도를 작성할 수 있습니다.
- 관계를 분석하는 깊이를 사용자 정의할 수 있습니다. 필요에 따라 특정 모듈에 지정할 수 있습니다.
코멘트 취득
- .NET 어셈블리 : 소스 코드의 코멘트로부터 C# 컴파일러에 의하여 생성된 C#코멘트 파일을 사용할 수 있습니다.
- Visual Basic 소스 코드 : Visual Basic의 소스 코드에서 취득하는 코멘트를 식별할 수 있습니다.
- Visual Basic 소스 코드 :코멘트의 취득원이 되는 속성 프로시저를 식별할 수 있습니다.
- COM 컴포넌트 : 기존의 HelpString속성의 사용 방법을 식별할 수 있습니다.
- 사용하는 모델 코멘트 프로파일을 식별할 수 있습니다. 모델 코멘트 프로파일은 공통설명 재이용이 가능한 세트입니다.
부속 툴
- 「Commentator! X」 Visual Basic 애드인에 의하여 Visual Basic 소스 코드의 탭 코멘트 작성과 보수가 지원됩니다.
- 「Document! X Commenter」는 X코멘트 파일을 작성하는 툴입니다. 코멘트 파일에서는 .NET 어셈블리, 데이터베이스, COM 컴포넌트, 타입라이브러리의 설명 리마크, 관련 항목의 링크 등의 작성과 관리를 실행할 수 있습니다.
코멘트의 추가
- 수동으로 작성된 컨텐츠 (HTML파일, 도면, Web링크)의 구성을 더 추가하는 것이 가능합니다.
- 관련항목 링크나 소스 코드 코멘트에 의하여 , 별개의 컨텐츠에 간단하게 링크할 수 있습니다.
- 추가 컨텐츠를 포함하여 사용자 목차 레이아웃을 작성할 수 있습니다.
- 생성된 토픽에 키워드를 더 추가할 수 있습니다.
샘플 코드의 작성과 관련성
- 단일 탭 코멘트를 사용하여 Visual Basic샘플 코드의 작성과 관련시킬 수 있습니다. (Visual Basic 프로젝트와 COM 컴포넌트만).
- 수동으로 작성된 샘플 토픽에 「예」링크나 「관련항목」링크를 추가할 수 있습니다.
컨텐츠 필터
- 조합 프로젝트, 모듈 및 멤버를 지정할 수 있습니다.
- 필요에 따라 와일드 카드 필터를 사용하고, 이름으로 멤버를 제외할 수 있습니다.
- 보호멤버, 프라이베이트 멤버, 프렌드 멤버의 제외나 구성을 실행하는 옵션이 있습니다.
- 멤버 타입 (메소드, 속성, 이벤트, 표, 인덱스 등)으로 제외나 구성을 실행하는 옵션이 있습니다.
다중설정 프로파일
- 각종 문서 타입에 다양한 독립 설정 프로파일을 작성할 수 있습니다 (온라인 헬프용, 내부 기술 문서용 등).
- 설정 프로파일은 Document! X를 Visual Basic에서 실행한 경우에 관련 문서로 저장됩니다.
- Visual Basic IDE 에서 설정된 파일을 더블 클릭하여 Document! X마법사를 자동적으로 기동합니다.
- 관련 문서로써 Visual Basic소스 컨트롤 (사용되고 있는 경우) 하에서 문서 설정을 배치할 수 있습니다.
템플레이트 베이스의 구조와 스타일
- 생성된 문서에 표준 컨텐츠를 추가할 수 있습니다. (용어집이나 기업정보 등).
- 기존의 템플레이트에 적응하며 기존의 기업 스타일과 컬러 스킴에 대한 조화가 가능합니다.
- 템플레이트와 HTML의 통합 에디터를 사용하며 새로운 템플레이트 작성과 수정이 가능합니다.
- 요건에 따라 복수의 목차 정의와 수정을 할 수 있습니다.
- Document! X 에서 사용되는 표준어구와 용어를 세밀하게 조정하여 표준에 맞출 수 있습니다.
생성, 편집, 갱신
- 생성된 HTML페이지의 수정이나 보충을 실행하여「갱신」을 유효하게 하여 재생산 할 수 있으며, 수정은 가능한 장소에서 가능합니다. (제한사항에 대하여는 온라인 헬프를 참조해주십시오)
- 왕복 헬프 생성에 의하여 수동으로 실행한 수정을 잃지않고 생성된 HTML 헬프 파일을 새로운 코드 멤버로 자동적으로 최신의 것으로 할 수 있습니다.
사용자 정의가 가능한 탭 코멘트와 설명의 유형
- 임의 멤버 유형 (Method、Property、Table、Index、Delegate 등) 과 관련시킬 수 있는 새로운 탭 코멘트 타입을 정의할 수 있습니다.
- 템플레이트 매니저를 사용하여 생성된 HTML 헬프 컨텐츠 임의의 장소에 새로운 코멘트 타입을 구성할 수 있습니다.
모델 코멘트 , 재이용 가능한 공통 설명
- 모델 코멘트 프로파일로 공통 설명을 정의하고, 그 이후의 프로젝트에서 자동적으로 재이용할 수 있습니다.
- 「ActiveX 컨트롤 이벤트」와「컬렉션 멤버」모델 코멘트 프로파일이 디폴트로 제공됩니다.
- 필요한 수의 모델 코멘트 프로파일에 대한 정의와 관리를 할 수 있습니다.
그 외의 기능
- Visual Basic 문서와 데이터 베이스 문서 : 색상이 있는 소스 코드 색상이 있는 소스 코드나 SQL문장을 생성하고 기술 문서에 부속됩니다.
- 변수 문서 생성 프로세스 안에 다양한 정보 항목에 대한 정의나 취득을 실행하고 페이지 레이아웃 템플레이트 또는 탭 코멘트를 이용하여 참조할 수 있습니다. 전형적인 예로「작성자」와 「릴리스 버전」을 들 수 있습니다.
