이번 Post에서는 Doxygen의 GUI Configuration Tool인 Doxywizard를 사용하여 편리하게 HTML, CHM 문서를 생성하는 방법을 설명합니다.

4. Doxywizard로 HTML 문서 만들기

Doxygen은 Command-line Tool이기 때문에 Command Interpreter(cmd.exe)를 사용하여 명령행으로 실행해야 합니다. 그리고 Doxygen을 사용하기 위해서는 Doxygen이 문서를 생성하기 위한 Configuration File이 필요합니다.

그러나 Doxygen의 Front-end인 Doxywizard를 사용하면 쉽게 Configuration File 만들 수 있고, 문서도 또한 쉽게 생성할 수 있습니다.

이번에는 가장 기본적인 문서인 HTML 문서를 생성하기 위해 Doxywizard를 사용하여 설정하는 방법과 실제 문서를 생성하는 방법을 알아봅시다.

Doxygen의 수많은 설정 Option을 설명할 수는 없기 때문에 Doxywizard를 처음 실행한 Default Option에서 꼭 필요하거나 설정하면 편리한 Option만 간단하게 설명합니다.

자세한 Option과 설명이 필요하다면 Doxygen Manual의 Reference Manual – Configuration Section을 참고하기 바랍니다.

Start Menu - Doxywizard

Doxywizard를 실행하기 위해서 시작 -> 프로그램 -> doxygen -> Doxywizard를 Click합니다.

Doxywizard - Save

Doxywizard가 위와 같이 실행되면 먼저 File -> Save를 Click하여 Doxygen Configuration을 저장할 File을 생성합니다. File의 위치는 Source Code Folder에서 문서 생성을 하위 Folder를 새로 만들어서 그 곳에 저장하는 것이 사용하기에 편리합니다.

Configuration File을 저장하면 Step 1에 Configuration File이 위치한 경로가 표시됩니다. 생성되는 HTML, CHM 문서는 이 곳에 생성됩니다. Configuration File에 Option 중 경로로를 입력해야 하는 Option이면 대부분 이 Folder에서 부터 상대경로(ex. ../Test)로 찾아가니 이점을 유의하기 바랍니다.

Step 2의 각 Tab에서는 설정을 관리하고 문서를 생성합니다. Wizard Tab으로 간단하게 설정할 수 있지만 Option이 너무 적기 때문에 Expert Tab에서 설정하는 것을 예로 들어 설명하겠습니다. (*로 표시한 것은 반드시 설정해야 합니다.)

4.1 Project Section

Doxywizard - Project

Project Section에서는 문서화하려는 대상 Project와 관련된 Option을 설정할 수 있습니다. Default 상태에서 다음과 같은 Option을 설정합니다.

• PROJECT_NAME : Project의 이름을 입력합니다. Project 이름은 나중에 생성된 HTML 문서의 최상단에 위치하게 됩니다.
• OUTPUT_LANGUAGE^* : 생성된 문서에서 사용하는 문자열에 대한 언어를 설정합니다. Korean으로 설정하면 생성된 문서에서 Doxygen이 자동으로 입력하는 문자열이 모두 한국어로 표시됩니다.
• TAB_SIZE : Source Code를 표시할 때 Tab 간격을 설정합니다. 각자 취향에 맞춰서 크기를 입력합니다.
• BUILTIN_STL_SUPPORT : Source Code에 STL를 사용할 경우(ex. std::vector) STL의 Source가 Project 내에 존재하지 않더라도 스스로 판단하여 관계를 표시합니다. STL를 상속받아서 사용하거나 Data Structure로 사용한 경우에는 Check하는 편이 좋습니다.

4.2 Build Section

Doxywizard - Build

Build Section에서는 Source Code에서 문서화를 할 요소들을 선택할 수 있습니다. 다음과 같은 Option을 취향에 맞게 설정합니다.

• EXTRACT_ALL : 상당히 세밀하게 Source Code에서 각 요소들을 분별하여 문서를 생성합니다. Private Class나 Static Member를 제외한 대부분의 요소에 대한 정보를 포함합니다. Source Code에 대한 자세한 정보를 얻기 위한다면 Check합니다.
• EXTRACT_PRIVATE : Check할 경우 Class의 Private Member도 문서에 포함됩니다.
• EXTRACT_STATIC : Check할 경우 Static Membr도 문서에 포함됩니다.
• SHOW_DIRECTORIES : Source가 여러 Folder로 되어있고 그 Folder들이 문서 생성을 위한 대상 Folder일 경우, Check하면 Folder의 구조를 생성된 문서에서 확인할 수 있습니다.

4.3 Input Section

Doxywizard - Input

Input Section은 Doxygen으로 문서를 생성할 Source Code의 위치를 지정하고 그와 관련된 Option을 설정합니다.

• INPUT^* : Doxygen으로 문서를 생성할 대상 Folder를 지정합니다. 위의 그림과 같이 오른쪽에 있는 각 Button을 통해서 개별 File이나 Directory를 추가할 수 있습니다. 추가되는 경로는 위의 Step1에 설정된 경로를 기준으로 상대경로로 입력됩니다. 물론 절대경로로도 입력할 수 있으나 추천하지는 않습니다.
• INPUT_ENCODING^* : Doxygen이 문서를 생성하기 위해 Source Code Parsing을 하기 위해서 Source Code에 대한 Encoding을 지정합니다. Borland C++ Builder 6로 생성한 Source에 한글이 들어가 있다면 CP949를 입력합니다.
• RECURSIVE^* : 위에 INPUT에 설정한 Folder의 하위 Folder가 존재하고 그 Folder에 Source Code가 존재한다면 Check하여 모두 검색하도록 합니다. Uncheck일 경우 하위 Folder를 검색하지 않습니다.

4.4 Source Browser Section

Doxywizard - Source Browser

Source Browser Section에서는 생성할 문서에 Source Code의 내용을 포함시키는 것과 관련된 Option을 설정할 수 있습니다.

• SOURCE_BROWSER : Check할 경우 생성할 문서에 Source Code의 Header 뿐만 아니라 Source의 내용이 추가되어 저장됩니다.
• INLINE_SOURCES : Check할 경우 생성할 문서에 각 Method나 Enum Type에 대한 설명 바로 밑에 해당 Code가 바로 표시됩니다.

4.5 HTML Section

Doxywizard - HTML

HTML 문서를 생성하기 위한 Option을 설정하는 Section입니다. Default 설정이 HTML 문서를 생성하게 되어있기 때문에 별로 수정할 것은 없으나 아래의 Option을 설정하면 편리합니다.

• GENERATE_TREEVIEW : Check할 경우 CHM 문서와 같이 생성된 HTML문서의 왼쪽 Frame의 전체 문서의 구조가 Treeview 형태로 표시됩니다.

4.6 LaTeX Section

Doxywizard - LaTeX

LaTeX는 문서 조판 System으로서 역사가 깊은 Program입니다. LaTex을 사용하면(System에 LaTeX이 설치되어 있는 경우) Source Code에 대한 PDF문서를 생성할 수 있지만, 여기서는 HTML문서를 생성할 것이므로 다음과 같이 설정합니다.

• GENERATE_LATEX^* : Uncheck하면 LaTeX 문서를 생성하지 않습니다.

4.7 Dot Section

Doxywizard - Dot

Dot Section에서는 Graphviz Package의 Program 중 하나인 Dot을 사용하여 Class Diagram이나 호출 관계도 등을 그리는 것에 대한 Option을 설정할 수 있습니다.

• HAVE_DOT^* : Dot이 System에 설치되어 있는지를 나타내는 Option입니다. 이전 Post에서 Graphviz를 설치했기 때문에 Check합니다.
• UML_LOOK^* : Check할 경우 Class의 상속 Diagram과 협업 Diagram을 UML에서 정의한 Style로 그립니다.

위와 같이 Option을 설정할 경우 Class의 상속 Diagram과 협업 Diagram이 아래와 같이 표시됩니다.

HTML - Class Diagram

4.8 Run

Doxywizard - Run Tab

이제 설정이 완료되었습니다. File -> Save를 Click하여 변경한 내용을 저장하고 Run Tab에서 Run doxygen Button을 Click하면 HTML문서를 생성합니다.

특별한 Error가 없다면 "Doxygen has finished"라는 Message가 표시될 것입니다. 문제가 생겼다면 설정을 다시 한번 확인해보기 바랍니다. Input Section의 INPUT Option에서 Source Code의 경로가 잘못되어 있는 것이 아니라면 대부분 제대로 생성될 것입니다.

생성된 HTML문서를 확인하기 위해서 아래의 Show HTML output Button을 Click하면 System의 기본 Browser를 통해서 생성된 HTML 문서를 확인할 수 있습니다. (생성된 문서는 Step1에 설정한 경로\html\index.html을 열어서 확인할 수도 있습니다.)

5. Doxywizard로 CHM 문서 만들기

Doxygen으로 생성한 HTML 문서는 여러 HTML과 CSS, Image 등으로 구성되어 있기 때문에 문서를 보관하거나 이동해서 가지고 다니는 용도로는 조금 부적합합니다.

Doxygen으로 생성할 수 있는 여러 문서 Type 중에서 CHM 문서를 생성하면, 하나의 File로 문서를 보관할 수 있고 또한 문서 내용을 검색할 수 있으며 굳이 문서를 읽기 위해 Viewer를 설치할 필요가 없이 Windows 환경에서 바로 열람이 가능합니다.

이번에는 Doxywizard를 사용해서 Source Code에 대한 CHM 문서를 만들어 봅시다.

5.1 HTML Help Workshop 설치

CHM은 Windows의 도움말 File(Microsoft Compiled HTML Help)의 확장자로 실제로는 HTML을 압축한 형태를 띠고 있습니다. 이 CHM 문서를 생성하기 위해서는 MS에서 제공하는 HTML Help Workshop이라는 Program을 설치해야 합니다.

HTML Help Workshop Download

HTML Help Workshop은 MS에서 무료로 배포하고 있으므로 HTML Help Workshop Page에 들어가서 위의 그림과 같이 htmlhelp.exe를 Download한 후 설치합니다.

5.2 Doxywizard 설정 (HTML Section)

Doxywizard - HTML

CHM을 생성할 때의 Doxywizard의 설정은 위의 HTML 문서를 생성할 때와 동일합니다. 다만 HTML Section에서 아래와 같은 Option을 더 설정해야 합니다.

• GENERATE_HTMLHELP^*: Check하면 CHM 문서를 생성합니다.
• CHM_FILE^*: CHM File이 저장되는 경로와 File명을 지정합니다. 유의할 것은 다른 설정과 달리 여기의 기본 Folder는 “Step1에서 지정한 Folder\html”입니다.
• HHC_LOCATION^*: HTML Help Workshop에서 CHM을 생성하는 Console Program인 hhc.exe의 경로를 지정합니다. 경로는 다음과 같습니다.
  32bit OS – C:\Program Files\HTML Help Workshop\hhc.exe
  64bit OS – C:\Program Files (x86)\HTML Help Workshop\hhc.exe
• CHM_INDEX_ENCODING^*: CHM 문서의 Index Encoding을 지정합니다. 한글이 사용된 경우 CP949를 입력합니다.

GENERATE_HTMLHELP를 Check하여 CHM 문서를 생성할 경우, HTML 문서의 왼쪽 Frame에 Treeview를 만들어 주는 GENERATE_TREEVIEW Option은 동작하지 않습니다.

5.3 Run

Doxywizard - Run

File -> Save로 설정을 저장한 다음, Run Tab에서 Run doxygen Button을 Click하면 CHM 문서가 생성됩니다. 위의 그림에 “Running html help compiler”라는 Text를 통해서 CHM 문서가 생성된다는 것을 확인할 수 있습니다.

CHM - Mainpage

만들어진 CHM 문서는 CHM_FILE Option에 설정한 경로에 해당 이름으로 생성됩니다. Double-click해서 문서를 열면 위와 같은 모습이 될 것입니다.

6. 마치면서…

이상으로 Doxygen을 사용하여 Borland C++ Builder 6로 구현한 Project를 문서화하는 방법을 알아봤습니다.

Project를 수행하는 것은 각자 개개인의 Programming 실력을 요구하지만, 또한 그것과 더불어 개발자 간의 Communication이 필요합니다. Doxygen을 이용한 문서화를 통해서 Project 구현에 대한 개발자 간의 Communication이 더 증진되기 바랍니다.

Doxygen을 사용하면 C++, C, C#, Fortran, Java, Objective-C, PHP, Python 등의 언어를 사용한 Source Code에 Doxygen에서 정의한 Style로 주석을 작성하면 자동으로 문서를 생성할 수 있게 됩니다.

생성된 문서는 마치 MSDN이나 기타 Live API Document와 같은 형식으로 Web Browser, PDF Reader, CHM Help 등으로 열람이 가능합니다. 이것은 여럿이 동시에 작업하는 Project에 더욱 유용합니다.

이번 Post에서는 Borland C++ Builder 6로 작성한 Project를 Doxygen을 사용하여 문서화하는 방법을 다루도록 하겠습니다.

1. Doxygen 설치

Doxygen 자체는 Source Code의 주석을 사용하여 문서를 자동으로 생성하는 도구로서 IDE와 통합되어 동작하지 않습니다. 다만 Doxygen에서 정의한 Style에 주석을 Project 개발시에 Source Code에 작성하면 됩니다. (Java, Flex의 경우에는 문서화 도구인 JavaDoc, ASDoc Style로 작성한 주석을 바로 Parsing하여 Eclipse에서 해당 Class나 Method에 대한 주석을 바로 확인할 수 있습니다.)

또한 Doxygen은 Cross-Platform Tool로서 Windows, Mac OS X, Linux (or Unix-like OS)에서 사용이 가능합니다. 이것은 Windows Application의 Source Code를 Doxygen에서 지정한 형식으로 주석을 작성해 놓으면, Web Server가 동작하는 다른 OS에서 Doxygen을 사용하여 Source Code 문서를 생성할 수 있다는 것을 말합니다. 한마디로 해당 Project에 대한 API Web Service(like MSDN)를 운영할 수 있게 됩니다.

이제 어느정도 설명이 끝났으니 설치를 해보도록 합시다. Doxygen의 Homepage에 접속합니다.

Doxygen Site

Program을 Download하기 위해서 오른쪽의 Download를 Click합니다.

Doxygen Download

여러 OS에 대한 Binary가 존재하는데 여기에서는 32-bit binary distribution for Windows XP/Vista/7 Section의 설치 File을 Download합니다.

Doxygen Install

Download한 설치 File을 설치합니다. 설치 중간에 위와 같이 Doxygen 구성요소가 나오는데 여기에서 Doxywizard GUI를 선택합니다.

Doxywizard를 사용하면 Command-line 기반의 Doxygen을 좀 더 편리하게 쓸 수 있습니다.

Graphviz Site

그리고 한 가지 더 설치해야 할 Tool이 있습니다. Doxygen은 문서를 생성할 때 Class나 Method의 관계를 나타내기 위해서 Graphviz라는 Tool을 사용합니다. 이번에는 Graphviz를 설치하도록 합시다.

Graphviz의 Homepage에서 왼쪽 Download를 Click합니다.

Graphiviz License Agreement

License 동의를 위해서 맨 아래쪽의 Agree를 Click합니다.

Graphviz Download

Windows – Stable and Development Windows Install Packages를 Click하여 Download한 후 설치하면 모든 준비는 완료됩니다.

2. Source Code에 문서화를 위한 Comment 작성

BCB6 - Doxygen Test Project

설치가 모두 끝났으니 이제 Source Code에 Doxygen Style의 주석을 달아봅시다. Style 및 사용하는 Metatag는 여러가지가 있는데 여기서는 간단하게 주로 사용하는 것을 Template 형태로 적어보도록 하겠습니다.

좀 더 자세한 내용을 알기 원한다면 아래의 Doxygen Manual을 참조하기 바랍니다.

• Online Manual : http://www.stack.nl/~dimitri/doxygen/download.html#latestman
• 설치된 Manual : C:\Program Files\doxygen\html\index.html
  (64bit OS일 경우에는 C:\Program Files (x86)\doxygen\html\index.html)

2.1 Class comment template

Class에 대한 주석을 작성할 때는 아래와 같이 작성하면 됩니다. 아래의 예제에서는 Class에 대한 주석 뿐만 아니라, 전역 변수, Method에 대한 주석도 설명하고 있습니다.

위와 같은 주석을 작성한 후, Doxygen으로 문서를 생성한 모습은 다음과 같습니다.

HTML - Class Description

2.2 Method comment template

Class의 Metho에 대한 주석을 작성할 때는 다음과 같이 작성하면 됩니다.

Parameter가 여러 개일 경우에는 Parameter의 순서대로 @param을 사용하여 설명을 적습니다. 개인적으로는 Debugging을 하기 위해서 header를 반복해서 살펴야 하는 Case를 가능하면 피하기 위해서 Method 주석은 header보다는 cpp에 적는 편입니다.

위와 같이 작성한 주석을 가지고 Doxygen으로 문서를 생성한 모습은 다음과 같습니다.

HTML - Method Description

2.3 Mainpage comment template

Mainpage는 Doxygen 문서의 Mainpage(index.html)를 주석으로 생성하는 것을 의미합니다. Mainpage 주석은 Source에 오직 한 군데만 작성해야 하며 이 곳은 주로 Project의 개관, 알아두어야 할 정보나 Compile 방법 등을 적어 놓는데 사용합니다.

위와 같은 Mainpage Comment를 Doxygen으로 문서화하면 다음과 같은 모습이 됩니다.

HTML - Mainpage

3. 마치면서…

이상으로 Doxygen을 설치하는 방법과 문서 생성을 위해 Source Code에 주석을 다는 방법을 알아봤습니다. 다음 Post에서는 Source Code에 작성한 주석을 Doxywizard를 사용해서 HTML과 CHM 문서로 만드는 방법을 알아보도록 하겠습니다.

이번 Post에서는 이런 경우에 Breakpoint를 정상적으로 동작하도록 설정하는 방법을 다뤄보도록 하겠습니다.

Method 1: Project Option을 확인

Project Options - Compiler

가장 먼저 이런 경우에 대처할 수 있는 방법은 Debugging하려는 최종 DLL, BPL 또는 EXE Project와 참조하는 모든 Static Library가 Debug Mode로 Compile 되었는지 확인하는 것입니다.

각 Project의 Project Option (Project -> Options…)에서 위와 같이 Compiler Tab에서 Full Debug를 눌러 Debugging과 관련된 Compiler Option이 Check되었는지 확인합니다.

이후 관련된 모든 Project를 다시 Build하면 Debug 시에 Breakpoint가 제대로 동작하게 될 것입니다.

이미 Full Debug 상태인데도 제대로 동작하지 않는다면, 관련된 LIB, DLL, BPL 등의 Source가 수정되었으나 Build가 되지 않은 상태이기 때문에 Source가 변경된 Project와 참조하는 다른 Projecct를 다시 Build할 필요가 있습니다.

Method 2: Module Load Breakpoint를 사용

Method 1을 실행했는데도 Breakpoint가 동작하지 않는 경우가 있습니다. 이 경우는 IDE인 Borland C++ Builder 6 자체의 문제로 Breakpoint를 잡아내지 못하는 경우입니다.

Source의 양이 많고 Project Group 내에 여러 Project가 포함되며 각 Project가 서로 참조할 경우(Static Linking, Dynamic Linking, Source 참조 etc.) 발생할 수 있습니다.

Borland C++ Builder 6는 Service Pack 4 이후에 추후 지원은 중단된 상태이기 때문에 이 문제에 대한 근본적인 해결방법은 없다고 할 수 있습니다. 다만, 다음과 같이 Module Load Breakpoint를 사용하면 임시적으로 문제를 해결할 수 있습니다.

BCB6 - Module Load Breakpoint

Module Load Breakpoint는 EXE Project에서 참조하는 EXE, DLL, BPL등이 Memory에 Load되는 시점을 Breakpoint로 설정하는 것입니다.

Loading 시점을 알기 힘든 DLL과 BPL 등을 Debugging하기 위해 만들어진 기능이지만 이 기능을 사용하면 해당 DLL, BPL 내의 Source에 설정한 Breakpoint도 제대로 동작하게 됩니다.

먼저 EXE Project를 실행하기 전에 Run -> Add Breakpoint -> Module Load Breakpoint를 선택합니다.

Add module

Add module Dialog가 표시되면 옆의 Browse를 눌러 Debugging하고자 하는 Source가 포함된 DLL, BPL, EXE등을 선택한 후, 확인을 누른 다음 원하는 Source에 Breakpoint를 설정하여 Debugging하면 됩니다.

예를 들어 Hello.EXE Project가 Hello.DLL을 Load한다면, Add module Dialog에서 Hello.DLL을 선택한 후 확인을 누르면 Hello.DLL Project 안의 Source(또는 Hello.DLL에 Link된 Static Library의 Source)에 Breakpoint를 설정하여 Debugging 할 수 있게 됩니다.

CPU View - Module Load Breakpoint

위의 그림은 DLL에 Module Load Breakpoint을 설정한 다음, 실행할 경우에 표시되는 CPU View입니다. Module이 Loading되는 최초의 순간에 Breakpoint가 설정되는 것이기 때문에 CPU View를 통해 Assembly Code로 보여집니다.

첫번째 jmp Line에 왼쪽 회색원이 Module Load Breakpoint를 나타냅니다. 그 원을 Click해서 Module Load Breakpoint를 해제하거나 Run -> Run을 Click하여 다음 Breakpoint로 넘어가면 됩니다.

Module Load Breakpoint는 Tools -> Environment Options에서 Preference Tab의 Autosave Options -> Project Desktop을 Check하여 저장할 수 있습니다. 그러나 일부 EXE에 설정한 Module Load Breakpoint는 저장되지 않기 때문에 IDE를 실행할 때마다 다시 설정할 필요가 있습니다.

Method 3: Debug Symbols Search Path를 설정

마지막으로 3번째 방법은 약간 단순무식하다고 볼 수 있습니다. 이 방법도 Method 1으로 문제가 해결되지 않을 때 취할 수 있는 방법으로, IDE가 Load될 때 Debugging Symbol을 검색하는 Directory를 강제적으로 지정함으로서 Breakpoint가 동작하는 않는 Project에서 Debugging이 가능하도록 설정하는 것입니다.

BCB6 - Debugger Options

Tools -> Debugger Options를 Click합니다.

Debugger Options - General

Debugger Options Dialog에서 General Tab의 하단에 Debug Symbols Search Path의 옆에 … Button을 Click합니다.

Debug Symbols Search Path - Directories

Directories Dialog에서 하단의 … Button을 눌러 Debugging하려는 DLL, BPL, EXE Project의 Output Directory(Build된 결과물이 위치한 Directory)를 선택한 다음 Add를 눌러 추가합니다.

마지막으로 OK를 눌러 설정완료한 다음, 원하는 곳에 Breakpoint를 설정하여 Debugging하면 됩니다.

이 방법의 단점은 Debug Symbols Search Path에 속한 DLL, BPL, EXE 등과 관련없는 Project를 개발할 때 Debug Symbol을 검색하기 위해서 이전에 설정한 Directory를 검색하게 된다는 것입니다. 그러나 IDE 실행마다 Module Load Breakpoint를 설정하는 것에 비하면 편리할 수도 있습니다.

하지만, Windows 7에 설치할 경우 아무래도 출시된 지 오래된 제품이다 보니 제대로 동작하지 않는 것들이 조금씩 보이는데 그 중의 하나가 바로 이 Help입니다. Borland C++ Builder 6에서 F1 Key를 누르거나 Help -> C++ Builder Help를 Click하면 아래와 같은 Dialog가 표시되면서 Help가 나오지 않는 것을 확인할 수 있습니다.

C++ Builder Help - Windows Help Warning

이번 Post에서는 Windows 7에서 Borland C++ Builder 6를 사용할 때 Help를 볼 수 있는 방법을 소개하도록 하겠습니다. 먼저 위와 같은 Dialog가 표시될 때 그림에 표시된 Microsoft 도움말 및 지원을 Click합니다. (또는 다음 Page에 Internet Explorer로 접속합니다.)

WinHlp32 Support Page

Borland C++ Builder 6의 Help가 표시되지 않는 이유는 WinHlp32라는 Program이 기본으로 설치되지 않기 때문입니다. 이 Program은 *.hlp 확장자를 갖는 도움말 File을 표시해주는 역할을 합니다.

WinHlp32 Support Page에 접속했으면 해결 방법에서 Windows 7용 Windows 도움말 프로그램(WinHlp32.exe)를 Click합니다.

Windows Help Program for Windows 7 Download Page

WinHlp32의 Download Page가 표시되면, Change Language에서 Korean을 선택합니다.

Windows Help Program for Windows 7 Download Page (Korean)

한국어 Download Page에서 계속을 누릅니다.

Install Windows Genuine Advantage

Download를 하기 전에 지금 사용하고 있는 Windows 7이 정품인지를 확인하기 위해서 Windows Genuine Advantage Plugin을 설치합니다. Internet Explorer 9의 아래쪽에 표시된 창에서 설치를 Click합니다. (이전 버전의 Internet Explorer는 위쪽에 표시됨.)

Windows Help Program for Windows 7 Download

Windows Genuine Advantage가 제대로 설치된 후, 인증이 완료되면 위와 같이 다운로드 Button이 표시됩니다.

Windows 7이 64bit일 경우에는 Windows6.1-KB917607-x64.msu의 다운로드 Button을, 32bit일 경우에는 Windows6.1-KB917607-x86.msu의 다운로드 Button을 Click합니다.

Instal WinHelp32

Download가 완료된 후, File을 실행하면 위와 같이 설치 Dialog가 표시됩니다. 확인을 누릅니다.

EULA

Software의 사용 조건이 표시됩니다. 동의함을 Click합니다.

Borland C++ Builder Help

설치 모두 완료된 후, Borland C++ Builder 6에서 Help를 실행하면 위의 그림과 같이 제대로 Help가 표시되는 것을 확인할 수 있습니다.

보통의 경우 하나의 Window 안에 Subwindow가 존재하는 Interface를 가지는데 반해, BCB6는 위쪽에 Main Window와 도구모음이 있고 그리고 그 아래에 Floating Window로 UI관련 설정을 할 수 있는 Object Inspector, Object Treeview, 그리고 Source Code View와 Class Explorer가 표시되는 다소 독특한 Interface를 하고 있습니다.

Default desktop

다소 정신이 없어 보이는 Interface지만 이것은 BCB 특유의 Interface로 취향에 따라 재구성한다면 오히려 하나의 Window에 모든 것을 표현하는 다른 IDE보다 자유롭고 개발에 편리한 환경을 만들 수 있습니다.

이번 Post에서는 Save Destop 기능을 활용하여 자신만의 BCB Interface(Desktop)을 만들어 보도록 하겠습니다.

1. Desktop Customizing

자신에게 맞는 Desktop은 여러가지가 있지만 편의를 위해서 제가 사용하는 Desktop을 가지고 설명하도록 하겠습니다.

회사 일을 하면서 여러가지로 Desktop을 변경해 보다가 최종으로 만든 Desktop인데 이 구성을 지금도 계속 사용하고 있습니다. Customizing하면서 우선적으로 고려한 것은 아래와 같습니다.

1. Project 관리가 편할 것
2. UI 편집(Form 변경 등)과 Source 편집에 용이할 것
3. Debugging이 편리할 것

View menu

먼저 Main Window의 View Menu를 보면 위와 같이 표시할 수 있는 여러 Floating Window의 종류가 나옵니다. 이 중에서 필요한 것들만 간단하게 설명해 보겠습니다.

• Project Manager : Project 관리에 꼭 필요한 Window입니다. Project에 포함된 Code를 관리할 수 있고, Project Group에 Project를 추가, 삭제할 수 있습니다.
• Object Inspector : Form과 포함된 각 Control의 Property를 설정할 수 있는 Window입니다.
• Object TreeView : Form에 포함된 각 Control을 Tree로 보여주는 Window입니다. Form에 포함된 Control이 복잡해서 변경하고자 하는 Control을 Mouse로 선택하기 힘들 때 Object TreeView를 사용하면 간단하게 선택할 수 있습니다.
• To-Do List : 처리해야 할 작업들을 관리하는 Window입니다. 개발하면서 개발에 관련된 간단한 To-do를 저장할 수 있습니다.
• Class Explorer : 현재 표시된 Source Code를 분석하여 Class와 그 안에 포함된 Property, Member, Method를 Tree로 표시합니다.
• Debug Windows : Debugging을 위한 Window로 Call Stack, Breakpoints, Watches 등등이 있습니다.

Project manager

이제 Desktop을 만들어 봅시다. View -> Project Manager를 Click하여 Project Manager를 표시합니다.

Project manager + Object Inspector

이미 화면에 표시되어 있는 Object Inspector를 Drag해서 Project Manager 위로 Mouse Cursor를 옮기면 위와 같이 사각형이 나타날 것입니다. 가운데 사각형이 표시될 때 Mouse 왼쪽 Button을 뗍니다.

Project manager, Object inspector in one window

그러면 위와 같이 Project Manager와 Object Inspector가 하나의 Window에 표시되는 것을 볼 수 있습니다.

Project manager,Object inspector,Object treeview,Call stack in one window

동일한 방법으로 Object TreeView, Call stack을 Drag하면 위의 그림과 같이 됩니다.

Right tab

Tab 선택을 좀 더 편리하게 하기 위해서 Tab위에서 Mouse 오른쪽 Button을 Click하면 위와 같이 Tab의 위치를 선택할 수 있는 Menu가 표시됩니다. 여기서 Right을 Click하여 Window의 오른쪽에 Tab이 표시되도록 합니다.

Left Window

이제 Window를 전체 화면의 왼쪽에 위치시키고 화면에 맞게 크기를 변경합니다. 그리고 오른쪽에 Edit Window(Source code가 표시되는 Window)의 크기를 화면에 맞게 변경하면 위의 그림처럼 됩니다.

이번에는 Edit Window를 Customizing 해 봅시다. 취향에 따라 차이가 있겠지만 Edit Window에 포함되어 있는 Class Explorer를 닫습니다. Source code가 방대할 경우 Class Explorer는 오히려 Memory를 많이 잡아먹고 IDE 전체를 느리게 만들기 때문에 개인적으로 사용하지 않습니다.

Message View menu

Edit Window에서 Mouse 오른쪽 Popup을 띄우면 위와 같은 Menu가 표시됩니다. 여기서 Message View를 Click합니다.

Add Message View

Message View는 Compile시 Error나 Warning을 표시하는 Window입니다. Message View를 Edit Window에 포함시키기 위해서 이전에 했던 방식과 동일하게 Drag한 후 Edit Window 아래쪽에 Box가 표시되면 Mouse 왼쪽 Button을 뗍니다.

View - Debug windows

이번에는 Debugging을 위해서 필요한 BreakPoint List를 추가해 봅시다. View -> Debug Windows -> Breakpoints를 Click합니다.

Add Breakpoint List

위와 같이 Breakpoint List가 표시되면 이전과 동일하게 Drag하여 추가하되, Message View안에 Docking될 수 있도록 위와 같은 Box 모양일 때 Mouse Button을 뗍니다.

Desktop Setup Complete

Breakpoint List를 추가한 방식과 동일하게 Watch List(View -> Debug Windows -> Watches)를 추가하면 위의 그림과 같은 Desktop이 완성됩니다.

Desktop toolbar

이제 Desktop을 모두 구성했으니 다음번에도 계속 이 구성으로 사용할 수 있도록 저장해 봅시다. Main Window의 오른쪽 Desktop Toolbar에서 위의 그림에 표시한 Save Current Desktop Button을 Click합니다.

Save desktop

저장할 Desktop의 이름을 입력하고 OK를 누르면 Desktop Customizing이 완료됩니다. BCB6를 종료한 후에 다시 실행해도 위와 같은 Desktop 구성을 계속 유지할 것입니다. 변경하거나 새로 만들려면 Desktop Toolbar를 이용하면 됩니다.

2. Editor Customizing

개발에 필수적인 Window를 재배치하여 자신에게 맞는 Desktop을 만들었다면 이제 편집환경을 변경해 봅시다.

이 부분은 개발자마다 취향이 다 다르므로 저의 경우에 맞춰서 설명하는 내용을 보고 자신에게 맞는 환경을 설정하면 될 것입니다.

Tool - Editor options

Main window에서 Tools -> Editor Options를 Click합니다.

Editor options : general

General Tab에서는 편집에 기본적인 설정을 변경할 수 있습니다. 대부분 Default를 사용하지만 제 경우에는 다음을 변경합니다.

• Undo after save : 저장 후에도 Undo를 수행할 수 있습니다. 종종 잘못 저장하는 경우를 위해 유용한 기능으로 Check하는 것이 좋습니다.
• Block indent : Shift key나 Mouse를 사용하여 Block를 설정한 다음 Tab key를 눌러 Indent를 주는 경우에 크기를 지정합니다. 저의 경우, Tab stops와 맞추어 4로 설정합니다.
• Tab stops : Tab Key를 눌러서 indent를 줄 경우에 크기를 지정합니다. 저는 주로 Block indent와 맞추어 4로 설정합니다.

Editor options : display

Display Tab에서는 다음을 변경합니다.

• Create backup file : 저장 시에 변경된 File에 대해서 Filename 끝에 ~를 붙인 Backup file을 생성합니다. 저의 경우. Source code directory가 지저분하게 느껴져서 Uncheck합니다. : )
• Editor font, size : Coding시에 가장 신경쓰이는 것 중 하나가 Font 입니다. 가독성이 좋은 Font를 사용하면 그 만큼 능률로 올라갑니다. 저의 경우는 System에 설치된 Courier New, 11pt를 사용합니다.

Editor options : Key mapping

Key mapping Tab에서는 IDE에서 사용하는 단축키 Scheme을 선택할 수 있습니다. 저는 Visual Studio를 같이 사용하는 경우가 있어서 Visual Studio emulation으로 설정합니다.

Editor options : colors

Colors Tab에서는 자신에게 맞는 Editor Color Scheme을 선택하고 세부 설정을 변경할 수 있습니다. 저의 경우는 Vim과 유사한 환경을 좋아하기 때문에 Color SpeedSetting에 Twilight을, 그리고 오른쪽 아래 미리보기 Panel에서 일부 변경해서 사용합니다.

Editor options : code insight

Code Insight Tab에서는 편집 시에 자동으로 Method나 Member, Property를 검색하여 입력하고자 하는 것을 고르거나 자동으로 입력해 주는 편의 기능에 대한 설정을 할 수 있습니다.

제 경우에는 Code Insight이 양이 많거나 복잡한 Source code에서는 시간과 Memory를 많이 잡아먹기 때문에 이 기능을 끄고 사용합니다. (끄기 위해서는 Automatic Features에서 Code completion, Code parameters, Tooltip expression evaluation, Tooip symbol insight을 Uncheck합니다.)

Code Templates는 편집 시에 Template Name을 입력한 후 Ctrl+Enter를 입력하면 자동으로 해당 Template의 Code를 입력해 주는 기능입니다. 필요한 Template을 추가하거나 편집할 수 있습니다. 편리한 기능이기는 한데 잘 사용하지는 않게 되더군요.

Customization Complete

Editor options 설정을 마친 후, 최종적으로 구성된 Desktop은 위의 그림과 같습니다. 마음에 드시나요? Post를 따라서 구성한 Desktop에서 마음에 들지 않는 부분이 있다면 이것저것 변경해 보시기 바랍니다. Coding을 잘 하는 것도 실력이지만 IDE를 잘 사용하여 능률을 높이는 것도 실력 향상에 도움이 될 것입니다.