KDevelop User Manual

时间:2011-03-13 14:11:03
【文件属性】:

文件名称:KDevelop User Manual

文件大小:2.94MB

文件格式:PDF

更新时间:2011-03-13 14:11:03

KDevelop Manual User

KDevelop User Manual

1 WhatThis ManualContains
2 Getting Startedwith KDevelop — a GuidedTour 3
2.1 AVeryFirstLook at KDevelop . . . . . . . . . . . . . . . . . . . 4
2.1.1 OntheSurface . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1.2 HowtoGetSomeHelp . . . . . . . . . . . . . . . . . . . 5
2.1.3 Whatis inthemenus? . . . . . . . . . . . . . . . . . . . . 6
2.1.4 Whatarethosetool viewsfor? . . . . . . . . . . . . . . . 8
2.2 ABit of Configuration . . . . . . . . . . . . . . . . . . . . . . . . 10
2.2.1 SomeGeneralSettings . . . . . . . . . . . . . . . . . . . . 10
2.2.2 InitializingDocumentation Search Indexes . . . . . . . . 12
2.3 StartingaNewProject . . . . . . . . . . . . . . . . . . . . . . . . 14
2.3.1 HowtoCreatea New Project . . . . . . . . . . . . . . . . 15
2.3.2 Initial ProjectFiles . . . . . . . . . . . . . . . . . . . . . . 17
2.3.2.1 CopyrightIssues . . . . . . . . . . . . . . . . . . 18
2.3.2.2 InitialSource Files . . . . . . . . . . . . . . . . . 19
2.3.2.3 InitialApplication Documentation . . . . . . . 20
2.3.2.4 Projectand Auxiliary Files . . . . . . . . . . . . 20
2.3.3 Additional Tool Views . . . . . . . . . . . . . . . . . . . . 21
2.3.3.1 Navigation andSelection Tools(leftside) . . . . 22
2.3.3.2 Messages(bottom) . . . . . . . . . . . . . . . . . 22
2.3.3.3 SourceManagement(rightside) . . . . . . . . . 22
2.4 SomeTipsAboutDealingWithDocuments . . . . . . . . . . . . 23
2.4.1 SwitchingBetween HeaderandImplementation Files . . 23
2.4.2 HowtoAccess Declarationsand Definitions . . . . . . . 24

KDevelopUserManual
2.4.2.1 ExternalDeclarations and Definitions . . . . . . 25
2.4.2.2 ProjectInternal Declarations andDefinitions . . 26
2.4.3 ArrangingEditor Windows . . . . . . . . . . . . . . . . . 29
2.4.3.1 CleaninguptheTabsRow . . . . . . . . . . . . 29
2.4.3.2 HowtoRearrange EditWindowTabs . . . . . . 30
2.4.3.3 ViewingSeveral FilesSimultaneously . . . . . . 31
2.4.3.4 EditC++SourceandHeaderFilesSimultaneously 32
2.4.3.5 GroupingSourceFilesIntoDevelopmentSessions 34
2.4.4 Keeping anEye onCommonProblems . . . . . . . . . . 36
2.5 How toCompileaProject . . . . . . . . . . . . . . . . . . . . . . 38
2.5.1 The BasicBuild Cycle . . . . . . . . . . . . . . . . . . . . 39
2.5.1.1 Initialize the Projectfor theBuild . . . . . . . . 39
2.5.1.2 InitialHello Configuration . . . . . . . . . . . . 41
2.5.1.3 Build the Project . . . . . . . . . . . . . . . . . . 43
2.5.1.4 RuntheApplication . . . . . . . . . . . . . . . . 44
2.5.2 Configuring the Project . . . . . . . . . . . . . . . . . . . 45
2.5.2.1 Build Configurations . . . . . . . . . . . . . . . 45
2.5.2.2 ProjectConfigureOptions . . . . . . . . . . . . 47
2.5.2.2.1 General ConfigurationSettings . . . . 49
2.5.2.2.2 Compiler Specific Settings . . . . . . . 49
2.5.2.3 HowMake ShouldBuild the Program . . . . . 51
2.5.2.4 HowtoRun the Executable . . . . . . . . . . . . 52
2.6 How toExtendaProject—the Automake Manager . . . . . . . 54
2.6.1 AShortLookat the AutomakeMachinery . . . . . . . . 55
2.6.2 HowtoPlace Icons inaSeparateDirectory . . . . . . . . 55
2.6.3 HowtoAdd New Classes . . . . . . . . . . . . . . . . . . 55
2.6.4 Whatis ina Subproject? . . . . . . . . . . . . . . . . . . . 55
2.6.4.1 Concentrate onYour Work — the Active Target 55
2.6.5 SomeSteps to Restructure aProject . . . . . . . . . . . . 55
2.7 How toDebug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
2.8 ANoteonYourProject Documentation . . . . . . . . . . . . . . 55
2.9 LastBut NotLeast,KeyboardShortcuts . . . . . . . . . . . . . . 56
2.10 Wheretogofromhere . . . . . . . . . . . . . . . . . . . . . . . . 56
2.10.1 Frequently EncounteredProblems . . . . . . . . . . . . . 56
2.10.2 WorkingWithProjects . . . . . . . . . . . . . . . . . . . . 56
2.10.2.1 UsingExistingKDevelop Projects . . . . . . . . 56
2.10.2.2 Importing ExternalProjects . . . . . . . . . . . 57
4

KDevelopUserManual
3 OverviewofKDevelopFeatures 58
3.1 AvailableUserInterface Modes . . . . . . . . . . . . . . . . . . . 59
3.1.1 HowtoSwitch User Interface Modes . . . . . . . . . . . 60
3.1.2 HowtoMaximizetheWorkSpaceArea . . . . . . . . . . 60
3.2 ElementsoftheUser Interface . . . . . . . . . . . . . . . . . . . . 61
3.2.1 The Workarea . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.2.2 The KDevelop Titlebar . . . . . . . . . . . . . . . . . . . . 61
3.2.3 The KDevelop Statusbar . . . . . . . . . . . . . . . . . . . 61
3.2.4 The menubar . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.2.5 The Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.2.6 The Tree Tool Views . . . . . . . . . . . . . . . . . . . . . 61
3.2.7 The OutputToolViews . . . . . . . . . . . . . . . . . . . 62
3.3 ProjectManagementSystems . . . . . . . . . . . . . . . . . . . . 62
3.3.1 AutomakeProjects . . . . . . . . . . . . . . . . . . . . . . 62
3.3.2 QMake Projects . . . . . . . . . . . . . . . . . . . . . . . . 62
3.3.3 CMake Projects . . . . . . . . . . . . . . . . . . . . . . . . 62
TM
3.3.4 ANT Projects (Java Projects) . . . . . . . . . . . . . . . 63
3.3.5 CustomProjects . . . . . . . . . . . . . . . . . . . . . . . . 63
3.3.6 HowtoDistributeYour Application . . . . . . . . . . . . 63
4 ConfiguringKDevelop 64
4.1 GeneralConfiguration . . . . . . . . . . . . . . . . . . . . . . . . 66
4.1.1 General Setup . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.1.2 Selectingthe UserInterface . . . . . . . . . . . . . . . . . 70
4.1.3 File Templates . . . . . . . . . . . . . . . . . . . . . . . . . 75
4.1.4 Selectingan Editor . . . . . . . . . . . . . . . . . . . . . . 75
4.1.5 Abbreviations for the WordCompletion . . . . . . . . . . 77
4.1.6 Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
4.1.7 AddingKDEStandardApplications totheTools Menu . 77
4.1.8 AddingExternal Applicationsto Menus . . . . . . . . . . 77
4.1.8.1 Adding to the ToolsMenu . . . . . . . . . . . . 77
4.1.8.2 Adding to the File Context Menu . . . . . . . . 77
4.1.8.3 Adding to the Directory Context Menu . . . . . 77
4.1.9 SelectingaSourceFormat Style . . . . . . . . . . . . . . . 77
5

KDevelopUserManual
4.1.9.1 General Formatting Setup . . . . . . . . . . . . 78
4.1.9.2 IndentationStyleSetup . . . . . . . . . . . . . . 79
4.1.9.3 Other FormattingSetup . . . . . . . . . . . . . . 82
4.1.10 SettingUptheCode SnippetsTool . . . . . . . . . . . . . 84
4.1.11 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.1.12 Configuring the File Selector . . . . . . . . . . . . . . . . 85
4.1.13 C++ ClassGenerator . . . . . . . . . . . . . . . . . . . . . 89
4.1.14 Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.1.15 C++ Parsing . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.2 ConfiguringtheDocumentation . . . . . . . . . . . . . . . . . . . 89
4.2.1 SettingUpDocumentation Collections . . . . . . . . . . 91
4.2.1.1 CommonDocumentation Setup Structure . . . 92
TM
4.2.1.2 Qt DocumentationCollections . . . . . . . . 93
4.2.1.3 SettingUptheCHMDocumentation Collection 95
4.2.1.4 Documentation Generatedby Doxygen . . . . . 95
4.2.1.5 Handling Structured Documentation (KDevel-
opTOC Files) . . . . . . . . . . . . . . . . . . . . 98
4.2.1.6 KDevelop TOC Files . . . . . . . . . . . . . . . . 100
4.2.1.7 DevHelpDocumentation . . . . . . . . . . . . . 101
4.2.1.8 SettingUpCustom DocumentationCollections 102
4.2.2 SettingUpTextSearch Indexes . . . . . . . . . . . . . . . 103
4.2.3 OtherDocumentationConfiguration Settings . . . . . . . 104
4.3 AdvancedConfiguration . . . . . . . . . . . . . . . . . . . . . . . 104
4.3.1 PluginTools . . . . . . . . . . . . . . . . . . . . . . . . . . 104
5 Getting Started—theApplicationWizard 105
5.1 New Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.1.1 Initial Steps . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.1.1.1 SelectProgrammingLanguageandApplication
107
Type . . . . . . . . . . . . . . . . . . . . . . . . .
5.1.1.2 Provide General Information . . . . . . . . . . . 108
5.1.2 Supply Version SystemInformation . . . . . . . . . . . . 111
5.1.3 Supply Header/SourceTemplates . . . . . . . . . . . . . 115
5.1.3.1 HowtoEdit the Templates . . . . . . . . . . . . 116
5.1.4 Build the InitialProjectFiles . . . . . . . . . . . . . . . . . 118
5.2 ConfiguringProjects . . . . . . . . . . . . . . . . . . . . . . . . . 119
6

KDevelopUserManual
6 EditingTools 120
6.1 CodeSnippets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
6.2 KeyboardMapping . . . . . . . . . . . . . . . . . . . . . . . . . . 120
6.3 TheProblemReporter . . . . . . . . . . . . . . . . . . . . . . . . 121
6.4 SearchingandGrepping . . . . . . . . . . . . . . . . . . . . . . . 121
6.4.1 SearchingforText . . . . . . . . . . . . . . . . . . . . . . . 121
6.4.2 ISearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
6.4.3 Grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
6.5 CodeCompletion . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
6.6 Creating New Filesand Classes . . . . . . . . . . . . . . . . . . . 123
6.6.1 EditingtheTemplates . . . . . . . . . . . . . . . . . . . . 123
7 TheFile Browsers 124
8 TheClassBrowsers 126
8.1 Class View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
8.2 Class Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
8.3 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
9 Documentation 129
9.1 TheDocumentation Browser . . . . . . . . . . . . . . . . . . . . 129
10 Buildingand ProjectManagement 131
10.1 Summary of Automake Manager . . . . . . . . . . . . . . . . . . 131
10.1.1 The Needfor an Automated BuildSystem . . . . . . . . 132
10.1.2 Tutorials on Autoconf/Automake/Libtool . . . . . . . . 133
10.1.3 WhatdoesAutomake ManagerDo? . . . . . . . . . . . . 133
10.1.4 SummaryofWhatAutomakeManagerDoes . . . . . . . 135
10.1.5 ContentsofAutomake Files . . . . . . . . . . . . . . . . . 135
10.2 AutomakeManagerOperation . . . . . . . . . . . . . . . . . . . 136
10.2.1 The Automake Manager Window . . . . . . . . . . . . . 137
10.2.2 The OverallViewWindow . . . . . . . . . . . . . . . . . 139
10.2.3 The Detail View Window . . . . . . . . . . . . . . . . . . 139
10.2.3.1 Targets . . . . . . . . . . . . . . . . . . . . . . . 140
10.2.4 Navigatingin the Automake Manager . . . . . . . . . . . 140
10.2.5 Popup Menusin the AutomakeManager . . . . . . . . . 141
7

KDevelopUserManual
10.2.5.1 The PopupMenuforaFile . . . . . . . . . . . . 141
10.2.5.2 The PopupMenuforaTarget . . . . . . . . . . 142
10.2.5.3 The PopupMenuforaSubproject . . . . . . . . 143
10.3 AutomakeProjects . . . . . . . . . . . . . . . . . . . . . . . . . . 145
10.3.1 Autoconf . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
10.3.2 Automake . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
10.3.3 KDevelop’sAutomakeManager . . . . . . . . . . . . . . 145
10.3.4 BuildingandInstalling Libraries . . . . . . . . . . . . . . 145
10.4 Custom Makefiles and Build Scripts . . . . . . . . . . . . . . . . 147
10.5 Compiler Options . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
10.6 MakeOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
11 AdvancedBuild Management 148
11.1 MultipleBuildConfigurations . . . . . . . . . . . . . . . . . . . . 148
11.2 Cross-Compiling . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
11.3 Qt/Embedded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
12 TheDebugger Interface 150
12.1 SettingBreakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . 152
12.2 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
13 UsingCVS 153
13.1 CVSBasics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
13.2 CVSCommandsinKDevelop . . . . . . . . . . . . . . . . . . . . 154
13.3 Behind the Scenes . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
13.3.1 WhatCVS Recordsin theWorkingDirectory . . . . . . . 154
14 Credits 155
14.1 Contributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
A Installing KDevelop 156
A.1 How toObtain KDevelop . . . . . . . . . . . . . . . . . . . . . . 156
A.1.1 GetDailyKDevelop Snapshots from svn . . . . . . . . . 156
A.1.1.1 Initialsvn Checkout . . . . . . . . . . . . . . . . 157
A.1.1.2 KeepingYour svnCopyuptoDate . . . . . . . 157
A.2 KDevelop Requirements . . . . . . . . . . . . . . . . . . . . . . . 158
8

KDevelopUserManual
A.3 KDevelop CompilationandInstallation . . . . . . . . . . . . . . 159
A.3.1 Preliminary Steps . . . . . . . . . . . . . . . . . . . . . . . 160
A.3.1.1 SettingtheEnvironmentfor thebash Shell . . . 160
A.3.1.2 SettingtheEnvironmentfor thetcsh Shell . . . 160
A.3.2 CompileKDevelop . . . . . . . . . . . . . . . . . . . . . . 160
A.3.2.1 Special svn CompilationConsiderations . . . . 161
A.3.2.2 Basic makeCommand Sequence . . . . . . . . . 161
A.3.3 Some Notes onconfigureOptions . . . . . . . . . . . . . 163
A.3.3.1 Non-defaultInstallationDirectory . . . . . . . . 163
A.4 How toObtain aKDevelopAPIDocumentation . . . . . . . . . 164
B In aNutshell—TipsandTricks 165
C DevelopmentonUNIX 168
C.1 SomeHistoricalRemarks . . . . . . . . . . . . . . . . . . . . . . . 168
C.2 Contemporary Scripting Languages . . . . . . . . . . . . . . . . 169
C.2.1 Perl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
C.2.2 Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
C.2.3 PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
C.3 Higher-levelScripting . . . . . . . . . . . . . . . . . . . . . . . . 169
C.3.1 The CORBAProtocol . . . . . . . . . . . . . . . . . . . . . 170
C.3.2 The DCOPInterface . . . . . . . . . . . . . . . . . . . . . 170
C.4 BuildSystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
C.4.1 The MakeProcess . . . . . . . . . . . . . . . . . . . . . . . 171
C.5 GUI Development . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
C.6 IntegratingConceptsandTools –the IDE . . . . . . . . . . . . . 172
C.6.1 BasicFeatures of KDevelop3.3.91 . . . . . . . . . . . . . 173
D ConfigurationFilesUsed byKDevelop 174
D.1 KDevelop Default Configuration . . . . . . . . . . . . . . . . . . 174
D.1.1 DefaultKDevelop Configuration . . . . . . . . . . . . . . 174
D.1.2 ApplicationSpecificDefaults . . . . . . . . . . . . . . . . 175
D.2 UserOrientedConfiguration . . . . . . . . . . . . . . . . . . . . 179
D.2.1 ApplicationSpecificConfiguration . . . . . . . . . . . . . 179
D.2.2 ResourceConfigurationFiles . . . . . . . . . . . . . . . . 181
D.3 ProjectDependentConfiguration . . . . . . . . . . . . . . . . . . 183
D.3.1 PersistentCode StoreFiles . . . . . . . . . . . . . . . . . . 183
9

KDevelopUserManual
E Plugin Tools 185
F KDevelopUserInterface Mode Examples 191
F.1 IDEAlMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
F.2 ChildFrameWindows Mode . . . . . . . . . . . . . . . . . . . . 192
F.3 Tabbed PagesMode . . . . . . . . . . . . . . . . . . . . . . . . . . 193
F.4 ToplevelWindows Mode . . . . . . . . . . . . . . . . . . . . . . . 194
G CommandReference 196
G.1 TheMenubar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
G.1.1 The FileMenu . . . . . . . . . . . . . . . . . . . . . . . . . 196
G.1.2 The EditMenu . . . . . . . . . . . . . . . . . . . . . . . . 197
G.1.3 The ViewMenu . . . . . . . . . . . . . . . . . . . . . . . . 198
G.1.4 The ProjectMenu . . . . . . . . . . . . . . . . . . . . . . . 199
G.1.5 The ProjectMenu . . . . . . . . . . . . . . . . . . . . . . . 199
G.1.6 The ProjectMenu . . . . . . . . . . . . . . . . . . . . . . . 200
G.1.7 The Bookmarks Menu . . . . . . . . . . . . . . . . . . . . 200
G.1.8 The Window Menu . . . . . . . . . . . . . . . . . . . . . . 200
G.1.9 The ToolsMenu . . . . . . . . . . . . . . . . . . . . . . . . 201
G.1.10 The Settings Menu . . . . . . . . . . . . . . . . . . . . . . 202
G.1.11 The Help Menu . . . . . . . . . . . . . . . . . . . . . . . . 202
H FurtherInformation 203
H.1 GettingInformation . . . . . . . . . . . . . . . . . . . . . . . . . . 203
H.2 ReportingBugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
H.3 Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
I Changes 204
I.1 ChangestoThis Document . . . . . . . . . . . . . . . . . . . . . 204
J Bibliography 205
J.0.0.0.0.1 Bibliography . . . . . . . . . . . 205
K Index 207


网友评论