차이

문서의 선택한 두 판 사이의 차이를 보여줍니다.

--- sandcastle를_이용한_api_문서_생성 [2012/09/14 13:04] – [Sandcastle 문서 생성 옵션] lindol
+++ sandcastle를_이용한_api_문서_생성 [2013/12/11 00:46] (현재) – 바깥 편집 127.0.0.1
@@ 줄 105: / 줄 105: @@
 {{::sandcastle_guided_installation_step13.jpg?300|}}
-===== Sandcastle 문서 생성 =====
+===== Sandcastle 문서 프로젝트 생성 =====
+**시작->모든 프로그램-> Sandcastile Help File Builder -> Sandcastle Help File Builder를** 이용해 프로그램을 실행 시킵니다.
+다음은 프로그램의 실행 화면입니다.
+{{::sandcastle_help_file_builder_1.jpg?300|}}
+메뉴에서 File-> New Project를 선택합니다.
+선택을 마치면 **Save New Help Project As** 다이얼로그가 표시되며 프로젝트가 생성될 디렉토리로 이동한 후 프로젝트 파일의 이름을 입력하도록 합니다.
+{{::sandcastle_help_file_builder_step_2.jpg?300|}}
+다음은 새로운 api 문서화 프로젝트가 생성된 화면입니다.
+{{::sandcastle_help_file_builder_step_3.jpg?300|}}
+===== 문서 프로젝트 설정 =====
+이제 문서를 생성할 c# project를 지정하도록 합니다.
+우측 영역의 **Project Explorer의 Documentation Sources 를 선택한** 후 마우스 우측 버튼을 클릭합니다.
+그리고 **Add Documentation Source 를** 선택합니다.
+{{::project_explorer_in_sandcastle_help_file_builder_step_4.jpg?300|}}
+메뉴를 선택하면 Select the documentation sources(s) 다이얼로그가 표시되며 여기서 문서를 생성할 프로젝트의 출력인 .exe 파일을 선택해 주도록 합니다. ( 또는 .dll 파일 )
+{{::sandcastle_help_file_builder_step_4.jpg?300|}}
+출력 파일을 선택하면 다음과 같이 앞서 생성했었던 XML 문서 파일과 함께 출력 파일이 Documeneation Source로 등록 됩니다.
+{{::sandcastle_help_file_builder_step_5.jpg?300|}}
+다음은 생성할 문서의 형태를 지정하고 추가적인 옵션을 설정하도록 합니다.
+Build 탭의 HtmlFileFormat 속성에서 출력할 문서의 형태를 지정할 수 있습니다.
+도움말 파일 형태로 문서를 만들고자 할 경우 HtmlHelp1 및 HtmlHelp2를 선택하고 웹 페이지 형태로 만들고자 할 경우 WebSite를 선택합니다.
+WebSite를 선택하도록 합니다.
+다음은 출력할 문서의 형태를 WebSite로 변경하는 화면입니다.
+{{::propeties_in_sandcastle_helpfile_builder_1.jpg?300|}}
+다음은 생성할 문서의 언어 및 제목 등의 기본적인 옵션을 지정하도록 합니다.
+Help File 탭에서는 이러한 옵션을 지정할 수 있으며 여기서는 생성할 언어를 한국어로 지정할 것입니다.
+다음은 Help File 탭의 Language 속성을 한국어로 지정하는 화면입니다.
+{{::propeties_in_sandcastle_helpfile_builder_2.jpg?300|}}
+이제 api 문서가 생성될 위치를 지정하도록 합니다. 문서가 생성될 위치는 OutputPath로 지정할 수 있습니다.
+다음은 Paths 탭의 OutputPath 속성을 지정하는 화면입니다.
+여기서는 ( C:\Users\LinDol\Documents\api document\ 로 지정하였음, 바탕화면에 하면 잘 안되더라는.. )
+{{::propeties_in_sandcastle_helpfile_builder_3.jpg?300|}}
+다음은 문서로 생성할 대상의( 클래스 및 기타 ) 범위를 지정하는 옵션입니다.
+기본적인 옵션 그대로 사용할 경우 접근 범위가 **public 로 지정된 클래스들을** 대상으로 하게 됩니다.
+다음은 가시성을 지정하는 화면 입니다.
+{{::propeties_in_sandcastle_helpfile_builder_4.jpg?300|}}
+모든 것이 완료 되었습니다.
+이제 메뉴에서 **Documentation -> Build Project를** 선택합니다.
+Build를 선택하면 다음 화면과 같이 문서를 생성하게 됩니다.
+{{::sandcastle_helpfile_builder_5.jpg?300|}}
+===== API 문서 =====
+다음은 OutputPath로 지정한 위치에 웹 페이지 형식으로 생성된 MSDN 스타일의 API 문서 입니다. ^.^
+문서 파일의 이름은 index.html 입니다.
+{{::api_webpage_generated_sandcastle.jpg|}}