Для роботи з проектами у '''KDevelop''' передбачено ''інструменти''. Інструмент надає певні дані щодо коду або виконує з ним певну дію. Інструментам відповідають кнопки вздовж периметра вікна програми (з вертикальним текстом на полях ліворуч і праворуч та горизонтальним вздовж нижнього поля). Якщо ви натиснете таку кнопку, у головному вікні буде відкрито підвікно — ''панель перегляду''; якщо кнопку буде натиснуто ще раз, відповідне підвікно буде закрито.
Для роботи з проектами у '''KDevelop''' передбачено ''інструменти''. Інструмент надає певні дані щодо коду або виконує з ним певну дію. Інструментам відповідають кнопки вздовж периметра вікна програми (з вертикальним текстом на полях ліворуч і праворуч та горизонтальним вздовж нижнього поля). Якщо ви натиснете таку кнопку, у головному вікні буде відкрито підвікно — ''панель перегляду''; якщо кнопку буде натиснуто ще раз, відповідне підвікно буде закрито.
{{Note_(uk)|1=Щоб закрити підлегле вікно, ви можете просто натиснути кнопку зі значком <menuchoice>x</menuchoice> у верхньому правому куті цього допоміжного вікна.}}
{{Note_(uk)|1=Щоб закрити підлегле вікно, ви можете просто натиснути кнопку зі значком <menuchoice>x</menuchoice> у верхньому правому куті (або у верхньому лівому куті для інструментів на нижньому полі) цього допоміжного вікна.}}
На наведеному вище зображенні ви можете бачити певний набір інструментів, вирівняних за лівим і правим полем. Ліворуч відкрито панель інструмента <menuchoice>Класи</menuchoice>, праворуч — <menuchoice>Фрагменти</menuchoice>. Посередині можна бачити панель редактора. З практичних міркувань, переважну частину часу розробки варто працювати лише з редактором та панеллю <menuchoice>Класи</menuchoice> чи <menuchoice>Перегляд коду</menuchoice>, відкритою ліворуч. На час використання певного інструмента можна відкрити його панель, яку після використання варто закрити з метою збільшення простору для панелі редактора.
На наведеному вище зображенні ви можете бачити певний набір інструментів, вирівняних за лівим і правим полем. Ліворуч відкрито панель інструмента <menuchoice>Класи</menuchoice>, праворуч — <menuchoice>Фрагменти</menuchoice>. Посередині можна бачити панель редактора. З практичних міркувань, переважну частину часу розробки варто працювати лише з редактором та панеллю <menuchoice>Класи</menuchoice> чи <menuchoice>Перегляд коду</menuchoice>, відкритою ліворуч. На час використання певного інструмента можна відкрити його панель, яку після використання варто закрити з метою збільшення простору для панелі редактора.
Line 17:
Line 17:
Після першого запуску '''KDevelop''' ви вже зможете скористатися кнопкою інструмента <menuchoice>Проєкти</menuchoice>. Натисніть цю кнопку: у відповідь буде відкрито панель зі списком проєктів, які було додано до сеансу у нижній частині вікна та панель перегляду файлової системи вашого проєкту у верхній його частині.
Після першого запуску '''KDevelop''' ви вже зможете скористатися кнопкою інструмента <menuchoice>Проєкти</menuchoice>. Натисніть цю кнопку: у відповідь буде відкрито панель зі списком проєктів, які було додано до сеансу у нижній частині вікна та панель перегляду файлової системи вашого проєкту у верхній його частині.
There are many [[Special:myLanguage/KDevelop5/Manual/Tool_list|other tools]] you can use with '''KDevelop''', not all of which are initially present as buttons on the perimeter. To add some, go to the <menuchoice>Windows -> Add tool view</menuchoice> menu entry which opens a dialog box allowing you to choose the desired tool view. A popup list is shown if you right-click on the left/bottom/right that allows you to choose a tool view as well as the side to place it on. Here are some that you will likely find useful:
У '''KDevelop''' ви можете скористатися багатьма [[Special:myLanguage/KDevelop5/Manual/Tool_list|іншими інструментами]], не всі з них представлено кнопками вздовж периметра вікна у початковому стані. Щоб додати кнопку, скористайтеся пунктом меню <menuchoice>Вікна -> Додати панель інструмента</menuchoice>. У результаті буде відкрито вікно для вибору бажаної панелі. У контекстному вікні ви зможете натискати кнопки ліворуч, вниз, праворуч для пересування панелей і вибору місця розташування панелей. Ось перелік можливих корисних інструментів:
* '''Класи''': повний список всіх класів, які визначено у одному з проектів або у вашому сеансі з усіма вбудованими функціями та змінними. Натискання пункту елемента класу відкриє вікно редактора з місцем оголошення елемента, пункт якого було натиснуто.
* '''Класи''': повний список всіх класів, які визначено у одному з проектів або у вашому сеансі з усіма вбудованими функціями та змінними. Натискання пункту елемента класу відкриє вікно редактора з місцем оголошення елемента, пункт якого було натиснуто.
Line 23:
Line 23:
* '''Документи''': тут буде показано список поточних відкритих у редакторі файлів.
* '''Документи''': тут буде показано список поточних відкритих у редакторі файлів.
* '''Code Browser''': Depending on your cursor position in a file, this tool shows things that are related. For example, if you are on an <code>#include</code> line, it shows information about the file you are including such as what classes are declared in that file. If you are on an empty line at file scope, it shows the classes and functions declared and defined in the current header file (all as links: clicking on them brings you to the point in the file where the declaration or definition actually is); if you are in a function definition, it shows where the declaration is and offers a list of places where the function is used.
* '''Перегляд коду''': залежно від розташування курсора у редакторі файла, на цій панелі буде показано пов’язані з кодом дані. Наприклад, якщо курсор перебуває у рядку з <code>#include</code>, на панелі буде показано дані щодо файла, який включено до коду, зокрема дані щодо оголошених у файлі класів. Якщо курсор перебуває на порожньому рядку у файлі, на панелі буде показано класи і функції, оголошені і визначені у поточному файлі (всі як посилання: натискання відповідного пункту відкриватиме файл з оголошенням або визначенням класу чи функції). Якщо курсор перебуває на визначенні функції, на панелі буде показано місце оголошення та список місць, у яких використано функцію.
* '''Файлова система''': показує ієрархічну структуру файлової системи.
* '''Файлова система''': показує ієрархічну структуру файлової системи.
* '''Documentation''': Allows you to search for man pages and other help documents such as c++, qt, php, etc.
* '''Документація''': надає вам змогу виконувати пошук даних на сторінках довідника (man) та у інших довідкових документах, зокрема документації до C++, Qt, PHP тощо.
* '''Snippets''': This provides sequences of text that one uses over and over and doesn't want to type repeatedly. For example, in the project from which the picture above was created, there is a frequent need to write code like: {{Input|1=<nowiki>if(vcs->isVersionControlled(source)) {
* '''Фрагменти''': на цій панелі буде наведено фрагменти тексту, які використовують вами регулярно, і які ви не хочете повторно вводити кожного разу. У прикладі, на основі якого було створено знімок екрана, була потреба часто використовувати фрагмент коду <syntaxhighlight lang="cpp" line>if(vcs->isVersionControlled(source)) {
VcsJob* job=vcs->copy(source, target);
VcsJob* job=vcs->copy(source, target);
if(job) {
if(job) {
return job->exec();
return job->exec();
}</nowiki>}}The code segment will look exactly like this every time you need to use such a segment of code — which would make it a good candidate for a snippet.
</syntaxhighlight>Цей вираз завжди використовуватиметься у такій формі кожного разу — чудовий кандидат на включення до списку фрагментів.
* '''Konsole''': Opens a command line window inside '''KDevelop's''' main window, for the occasional command you may want to enter (e.g. to run <code>./configure</code>).
* '''Konsole''': відкриває панель командного рядка у головному вікні '''KDevelop''', щоб ви могли віддати потрібну вам команду оболонки (наприклад, виконати <code>./configure</code>).
For many programmers, vertical screen space is the most important. To this end, you can arrange your tool views at the left and right margin of the window: to move a tool, click on its symbol with the right mouse button and select a new position for it.
Для багатьох програмістів найважливішою є економія вертикального місця на екрані. Щоб досягти такої економії, ви можете розташувати панелі інструментів вздовж лівої та правої межі вікна програми. Щоб пересунути панель, клацніть на заголовку правою кнопкою миші і виберіть нове її розташування.
<span id="Exploring source code"></span>
<span id="Exploring source code"></span>
=== Exploring source code ===
=== Огляд роботи з кодом ===
==== Local information ====
==== Локальні дані ====
'''KDevelop''' ''understands'' source code, and as a consequence, it is really good at providing you information about variables or functions that may appear in your program. For example, here is a snapshot of working with a piece of code and hovering the mouse over the symbol <code>container</code> in line 390 (if you are working keyboard-oriented, you can achieve the same effect by holding down the <keycap>Alt</keycap> key for a while):
'''KDevelop''' ''розуміє'' код програми, тому це середовище може надавати вам дані щодо змінних або функцій вашої програми. Наприклад, у цьому підручнику наведено знімок роботи з фрагментом коду, де вказівник миші наведено на символ <code>cell</code> у рядку 1316 (якщо ви надаєте перевагу роботі за допомогою клавіатури, того самого ефекту можна досягти утримуванням певний час натиснутою клавіші <keycap>Alt</keycap>):
'''KDevelop''' shows me a tooltip that includes the type of the variable <code>container</code>, where this variable is declared (the ''container'', which
'''KDevelop''' показує підказку, зокрема тип змінної (тут: <code>container</code>), де цю змінну оголошено (''контейнер'', яким тут є функція-обгортка <code>operator()(AreaIndex *index)</code>, оскільки це локальна змінна), тип даних (змінна, не функція, клас або простір назв) та місце оголошення (у рядку 376, декількома рядками коду вище).
here is in the surrounding function <code>operator()(AreaIndex *index))</code>, what it is (a variable, not a function, class or namespace) and where it is declared (in line 376, just a few lines up in the code).
In the current context, the symbol over which the mouse was hovering, has no associated documentation. In this example, had the mouse hovered over the symbol <code>Container</code> in line 376, the outcome would have been this:
У поточному контексті з символом, на який наведено вказівник миші, не пов’язано жодної документації. У нашому прикладі, де вказівник миші наведено на символ <code>Container</code> у рядку 376, буде показано такі дані:
Here, '''KDevelop''' has cross-referenced the declaration from an entirely different file (<code>container.h</code>, which resides in the same project of the same session) together with the doxygen-style comment that accompanies the declaration there.
Тут '''KDevelop''' показано оголошення зі стороннього файла (<code>container.h</code>, який є частиною зовсім іншого проекту того самого сеансу) разом з коментарем у форматі doxygen, який супроводжує цей оголошення.
What makes these tooltips even more useful is that they are dynamic: I can click on the container to get information about the context in which the variable is declared (i.e. about the namespace <code>Sublime</code>, such as where it is declared, defined, used, or what its documentation is) and I can click on the blue links that will reset the cursor position to the location of the declaration of the Symbol (e.g. in <code>container.h</code>, line 40) or give me a list of places where this symbol is used in the current file or throughout all the projects of the current session. The latter is often useful if you want to explore how, for example, a particular function is used in a large code basis.
Кориснішими ці підказки робить те, що вони є динамічними: ви можете клацнути на пункті контейнера, щоб отримати відомості щодо контексту, у якому оголошено змінну (тобто щодо простору назв <code>Sublime</code>, зокрема того, де її оголошено, визначено, використано або якою є її документація), і ви можете клацнути на розфарбованих у синє посилань для перенесення позиції курсора до місця оголошення символу (наприклад, у <code>container.h</code>, рядок 40) або отримання списку місць, де цей символ використано у поточному файлі або в усіх проєктах поточного сеансу. Останній варіант часто корисним, якщо ви хочете вивчити те, як, наприклад, певну функцію використано у великій кодовій базі.
{{Note|1=The information in a tooltip is fleeting — it depends on you holding the <keycap>Alt</keycap> key down or hovering your mouse. If you want a more permanent place for it, open the <menuchoice>Code Browser</menuchoice> tool view in one of the sub-windows. For example, here the cursor is on the same function as in the example above, and the tool view on the left presents the same kind of information as in the tooltip before:<!--}}-->
{{Note_(uk)|1=Панель підказки з часом зникатиме: щоб її знову відкрити доведеться знов утримувати натиснутою клавішу <keycap>Alt</keycap> або наводити вказівник миші на фрагменти коду. Якщо вам потрібно зафіксувати дані з цієї панелі, відкрийте панель інструмента <menuchoice>Перегляд коду</menuchoice>. У нашому прикладі курсор перебуває у тій самій функції, що і раніше, а на панелі інструмента ліворуч показано той самий набір даних, що і на панелі підказки раніше:<!--}}-->
<!--{{-->Moving the cursor around on the right changes the information presented on the left. What's more, clicking on the <menuchoice>Lock current view</menuchoice> button at the top right allows you to lock this information, making it independent of the cursor movement while you explore the information presented there.}}
<!--{{-->Пересування курсора у правій частині вікна призводитиме до зміни даних у його лівій частині. Натискання кнопки <menuchoice>Заблокувати поточний перегляд</menuchoice> у верхній правій частині надасть вам змогу зафіксувати дані, убезпечивши їх від зміни розташування курсора на час перегляду.}}
{{Note|1=This sort of context information is available in many other places in '''KDevelop''', not just in the source editor. For example, holding down the <keycap>Alt</keycap> key in a completion list (e.g. when doing a quick-open) also yields context information about the current symbol.}}
{{Note_(uk)|1=Доступ до контекстних даних такого типу можна отримати з багатьох частин '''KDevelop''', не лише з панелі редактора коду. Наприклад, утримування натиснутою клавіші <keycap>Alt</keycap> у списку автоматичного доповнення (наприклад, під час пришвидшеного відкриття якогось файла) також призводитиме до показу контекстних даних щодо поточного рядка.}}
==== File scope information ====
==== Дані щодо окремих файлів ====
The next level up is to obtain information about the entire source file you are currently working on. To this end, position the cursor at file scope in the current file and look at the what the '''Code Browser''' tool view shows:
Наступним рівнем є отримання даних щодо всього файла коду, над яким ви працюєте. Щоб переглянути її, розташуйте курсор на початку поточного файла і подивіться на дані, які буде показано на панелі інструмента '''Перегляд коду''':
Here, it shows a list of namespaces, classes and functions declared or defined in the current file, giving you an overview of what's happening in this file and a means to jump directly to any of these declarations or definitions without scrolling up and down in the file or searching for a particular symbol.
Тут середовищем показано список просторів назв, класів та функцій, оголошених або визначених у поточному файлі. За допомогою цього списку ви можете ознайомитися з загальними даними щодо дій, які виконуються у файлі, та безпосередньо перейти до будь-якого з оголошень або визначень без потреби у гортанні коду файла або пошуку певного фрагмента.
==== Project and session scope information ====
==== Дані щодо проектів та сеансів ====
There are many ways to obtain information about an entire project (or, in fact, about all projects in a session). This sort of information is typically provided through various tool views. For example, the <menuchoice>Classes</menuchoice> tool view provides a tree structure of all classes and surrounding namespaces for all projects in a session, together with the member functions and variables of each of these classes:
Існує багато способів отримати загальні дані щодо проекту (або, фактично, всіх проектів сеансу). Такі дані, зазвичай, можна знайти на панелях перегляду різноманітних інструментів середовища. Наприклад, на панелі інструмента <menuchoice>Класи</menuchoice> показано ієрархічну структуру всіх класів і зовнішніх просторів назв для всіх проектів сеансу, разом з вбудованими функціями та змінними кожного з цих класів:
Hovering over an entry provides again information about the symbol, its location of declaration and definition, and its uses. Double-clicking on an entry in this tree view opens an editor window at the location where the symbol is declared or defined.
Знову ж таки, за допомогою наведення вказівника миші на запис у списку можна отримати дані щодо відповідного символу, розташування його оголошення та визначення і випадків використання. Подвійним клацанням на пункті цього ієрархічного списку можна відкрити вікно редактора на позиції, де оголошено або визначено символ.
But there are other ways of looking at global information. For example, the <menuchoice>Documents</menuchoice> tool provides a view of the documents that are
Але існують інші способи вивчення загальних відомостей. Наприклад, інструмент <menuchoice>Документи</menuchoice> надає панель перегляду документів, які відкрито, і надає можливість вибору одного з документів для перегляду і безпроблемного пересування від одного документа до іншого:
open and allows selection of one to view and move easily from one to another:
You can also select the little box of four cubes in the upper right corner to get a list of the open files, termed ''the working set''. Each line starts with a checkable cube that removes the file from the working set when checked. You also have a button on the right side that when pressed, allows you to do a git stash. Useful when you need to change to a different branch or a totally different project.
Ви також можете вибрати пункт із маленькою коробкою із чотирма кубиками у верхньому правому куті, щоб отримати список відкритих файлів, який має назву ''робочий набір''. Кожен рядок починається з поля для позначки, позначення якого вилучає файл з робочого списку. Також буде показано кнопку у правій частині, натискання якої надає вам змогу виконати записування до реєстру git. Корисно, якщо вам потрібно перейти до іншої гілки або до повністю іншого проєкту.
'''KDevelop''' uses a variety of colors to highlight different objects in source code. If you know what the different colors mean, you can very quickly extract a lot of information from source code just by looking at the colors, without reading a single character. The highlighting rules are as follows:
'''KDevelop''' використовує різноманітні кольори для підсвічування різних об'єктів у початковому коді. Якщо ви знаєте призначення різних кольорів, ви можете швидко отримати багато інформації з початкового коду простим його переглядом (за кольорами) навіть не читаючи сам код. Правила підсвічування такі:
* Objects of type Class / Struct, Enum (the values and the type), (global) functions, and class members each have their own color assigned (classes are green, enums are dark red, and members are dark yellow or violet, (global) functions are always violet).
* Для об'єктів типів Class / Struct, Enum (значень і типу), (загальних) функцій і членів класу визначено власні кольори (класи — зелені, переліки — темно-червоні, а учасники — темно-жовті або фіолетові, (загальні) функції — завжди фіолетові).
* All global variables are colored in dark green.
* Усі загальні змінні буде розфарбовано у темно-зелений.
* Identifiers which are typedefs for another type are colored in teal.
* Ідентифікатори, які є визначеннями типів для інших типів буде розфарбовано у синьо-зелений колір.
* All declarations and definitions of objects are in bold.
* Усі оголошення та визначення об'єктів буде показано напівжирним шрифтом.
* If a member is accessed from within the context where it is defined (base or derived class) it appears in yellow, otherwise it appears in violet.
* Якщо доступ до учасника класу отримується з контексту, де його визначено (базового або похідного класу), його буде показано жовтим. Якщо ж це не так, його буде показано фіолетовим.
* If a member is private or protected, it gets colored in a slightly darker color when used.
* Якщо член класу є приватним (private) або захищеним (protected), його буде розфарбовано у дещо темніший колір при використанні.
* For variables local to a function body scope, rainbow colors are picked based on a hash of the identifier. This includes the parameters to the function. An identifier always will have the same color within its scope (but the same identifier will get a different color if it represents a different object, i.e. if it is redefined in a more nested scope), and you will usually get the same color for the same identifier name in different scopes. Thus, if you have multiple functions taking parameters with the same names, the arguments will all look the same color-wise. These rainbow colors can be turned off separately from the global coloring in the settings dialog.
* Для змінних, які є локальними для області видимості функції, використовуються кольори веселки, які програма вибирає за хешем ідентифікатора. Це стосується і параметрів функції. Ідентифікатор матиме той самий колір у її області видимості (але той самий ідентифікатор матиме інший колір, якщо відповідає іншому об'єкту, тобто його перевизначено у вкладенішій області видимості). Зазвичай, для ідентифікатора із тією самою назвою у різних областях видимості буде використано той самий колір. Отже, якщо параметри із однаковими назвами приймають декілька функцій, кольори аргументів будуть однаковими. Розфарбовування у кольори веселки можна вимкнути окремо на рівні сторінки налаштовування загального розфарбовування у діалоговому вікні параметрів програми.
* Identifiers for which '''KDevelop''' could not determine the corresponding declaration are colored in white. This can sometimes be caused by missing <code>#include</code> directives.
* Ідентифікатори, для яких '''KDevelop''' не вдалося визначити відповідне оголошення, буде розфарбовано білим кольором. Іноді причиною такого розфарбовування є пропущені директиви <code>#include</code>.
* In addition to that coloring, the normal editor syntax highlighting will be applied, as known from '''Kate'''. '''KDevelop's''' semantic highlighting will always override the editor highlighting if there is a conflict.
* На додачу до цього розфарбовування буде застосовано звичайне розфарбовування синтаксичних конструкцій редактора, які відомі з '''Kate'''. Семантичне підсвічування у '''KDevelop''' завжди перевизначає підсвічування редактора, якщо виникне конфлікт.
<span id="Navigating in source code"></span>
<span id="Navigating in source code"></span>
=== Navigating in source code ===
=== Пересування між фрагментами коду ===
In the previous section, we have discussed exploring source code, i.e. getting information about symbols, files and projects. The next step is then to jump around your source base, i.e. to navigate in it. There are again various levels at which this is possible: local, within a file, and within a project.
У попередньому розділі ми обговорювали вивчення коду програми, тобто отримання даних щодо символів, файлів та проектів. Наступним кроком є перехід між компонентами коду, тобто навігація кодом. Знову ж таки, існує декілька рівнів, на яких можна здійснювати подібну навігацію: локально, у межах файла і у межах проекту.
{{Note|1=Many of the ways to navigate through code are accessible from the <menuchoice>Navigate</menuchoice> menu in the '''KDevelop''' main window.}}
{{Note_(uk)|1=Доступ до багатьох засобів навігації можна отримати за допомогою меню <menuchoice>Навігація</menuchoice> головного вікна '''KDevelop'''.}}
==== Local navigation ====
==== Пересування поточним фрагментом ====
'''KDevelop''' is much more than an editor, but it is ''also'' a source editor. As such, you can, of course, move the cursor up, down, left or right in a source file. You can also use the <keycap>PageUp</keycap> and <keycap>PageDown</keycap> keys, and all the other commands you are used from any useful editor.
'''KDevelop''' — набагато більше, ніж просто редактор, — це ''також'' редактор коду. Тому, звичайно ж, ви можете пересувати курсор текстом за допомогою звичайних клавіш зі стрілочками. Ви також можете скористатися натисканням клавіш <keycap>PageUp</keycap> та <keycap>PageDown</keycap> і всіма іншими командами, якими можна скористатися у звичайному текстовому редакторі.
==== File scope navigation and outline mode ====
==== Пересування файлами та режим огляду ====
At the file scope, '''KDevelop''' offers many possible ways to navigate through source code. For example:
На рівні окремого файла у '''KDevelop''' передбачено багато способів навігації кодом програми. Приклад:
* '''Outline''': You can get an outline of what is in the current file in at least three different ways:
* '''Схема''': ви можете переглянути схему вмісту поточного файла в один із принаймні трьох різних способів:
** Clicking on the <menuchoice>Outline</menuchoice> ''Tool View'' button that is generally located on the left border.[[Image:Kdevelop-outline1.png|625px|thumb|center]]There is a button to sort everything in ascending or descending order and a filter edit box. You can then just select which one to jump to, or — if there are a lot — start typing any text that may appear in the names shown in the filter edit box. In that case, as you keep typing, the list becomes smaller and smaller as names are removed that don't match the text already typed until you are ready to select one of the choices.
** Натисканням кнопки <menuchoice>Outline</menuchoice> ''Панелі інструментів'', яку, зазвичай, розташовано у лівій частині вікна.[[Image:Kdevelop-outline1.png|625px|thumb|center]]Передбачено кнопку для упорядковування усього за зростанням або спаданням та панель фільтрування. Далі, ви можете просто вибрати пункт, до якого слід перейти, або, якщо пунктів багато, почати вводити критерій пошуку, щоб у списку лишилися потрібні вам записи. Зі зростанням кількості символів у введеному критерії, список ставатиме усе меншим, оскільки з нього зникатимуть усі назви, які не містять введеного вами тексту, аж доки ви не будете готові вибрати один з варіантів, що лишився у списку.
** Hot-keys <keycap>Alt + Ctrl + N</keycap> opens a dialog box that lists all function and class declarations.[[Image:Kdevelop-outline2.png|625px|thumb|center]]This also provides you with an outline of what is happening in the current file, allows you to search if the list is long, and allows you to select where you want to jump to.
** Комбінацією клавіш <keycap>Alt + Ctrl + N</keycap> можна відкрити діалогове вікно зі списком усіх оголошень функцій та класів.[[Image:Kdevelop-outline2.png|625px|thumb|center]]Там також буде наведено опис того, що відбувається у поточному файлі. Крім того, у цьому діалоговому вікні ви зможете виконати пошук, якщо список є надто довгим, та вибрати оголошення для переходу до нього.
** The code browser toolbar has a line edit in the toolbar that you can type in a function or class name to quickly find it, or just click in the line edit and it shows an outline. If an item in the pop-up is clicked, you get the tooltip for the item with information and links about its definition and usage.[[File:Kdevelop-outline4.png|400px|thumb|center]]
** На панелі інструментів вікна навігації кодом передбачено смужку редагування тексту, до якої ви можете ввести назву функції або класу для швидкого пошуку. Можна просто клацнути на смужці редагування, щоб побачити схему. Якщо клацнути на пункті у контекстному списку, програма покаже підказку щодо пункту і посилання на його визначення та використання.[[File:Kdevelop-outline4.png|400px|thumb|center]]
* Source files are organized as a list of function declarations or definitions. Hitting <keycap>Alt + Ctrl + PgUp</keycap> and <keycap>Alt + Ctrl + PgDown</keycap> jumps to the previous or next function definition in this file.
* Файли коду впорядковано у список оголошень та визначень. За допомогою натискання комбінацій клавіш <keycap>Alt + Ctrl + PgUp</keycap> і <keycap>Alt + Ctrl + PgDown</keycap> можна переходити до визначення попередньої або наступної функції у файлі.
==== Project and session scope navigation: Semantic navigation ====
==== Пересування проектами та сеансами: семантичне пересування ====
As mentioned in other places, '''KDevelop''' does not usually consider individual source files but rather looks at projects as a whole (or, rather, at all projects that are part of the current session). As a consequence, it offers many possibilities for navigating through entire projects. Some of these are derived from what we have already discussed in the section on [[Special:myLanguage/KDevelop5/Manual/Working with source code#Exploring source code|Exploring source code]] while others are genuinely different. The common theme is that these navigation features are based on a ''semantic understanding'' of the code, i.e. they offer you something that requires parsing entire projects and connecting data. The following list shows some ways how to navigate through source code that is scattered throughout a potentially very large number of files:
Як ми вже згадували у інших частинах підручника, '''KDevelop''', зазвичай, не працює із окремими файлами початкових кодів, а розглядає проєкти програмного забезпечення уцілому (або, точніше, розглядає як ціле усі проєкти, які є частиною поточного сеансу). Наслідком цього є те, що програма пропонує багато можливостей для навігації усіма проєктами. Деякі з цих можливостей є похідними від тих, які вже було обговорено у розділі щодо [[Special:myLanguage/KDevelop5/Manual/Working with source code#Exploring source code|вивчення початкового коду]], інші ж є цілком відмінними. Загальним є те, що ці можливості з навігації засновано на ''семантичному розумінні'' коду, тобто вони пропонують вам щось, що потребує обробки коду усіх проєктів і поєднання даних. У наведеному нижче списку описано деякі способи для навігації початковим кодом, який розкидано між потенційно великою кількістю файлів:
* As seen in the section on [[Special:myLanguage/KDevelop5/Manual/Working with source code#Exploring source code|Exploring source code]], you can get a tooltip explaining individual namespace, class, function or variable names by hovering your mouse over it or keeping the <keycap>Alt</keycap> key pressed for a while. Here is an example: [[Image:kdevelop-class-doc-tooltip.png|thumb|525px|center]] Clicking on the links for the declaration of a symbol or expanding the list of uses allows you to jump to these locations, if necessary opening the respective file and placing the cursor at the corresponding location. A similar effect can be achieved by using the '''Code Browser''' tool view also discussed previously.
* Як зазначалося у розділі щодо [[Special:myLanguage/KDevelop5/Manual/Working with source code#Exploring source code|огляду початкового коду]], програма може показувати панель підказки із поясненнями щодо простору назв, класу, функції або назв змінних у відповідь на наведення на його пункт вказівника миші або утримання протягом певного часу натиснутою клавіші <keycap>Alt</keycap>. Ось приклад: [[Image:kdevelop-class-doc-tooltip.png|thumb|525px|center]] Клацання на посиланнях оголошення символу або розгортання списку використань надає вам змогу переходити до відповідних місць коду. Якщо потрібно, буде відкрито відповідний файл, і курсор буде переміщено до відповідного місця. Такого самого результату можна досягти використанням панелі '''Навігація кодом''', яку ми описували раніше.
* '''Quick open''': A very powerful way of jumping to other files or locations is to use the various ''quick open'' methods in '''KDevelop'''. There are four versions of these:
* '''Швидко відкрити''': дуже потужний спосіб переходу до інших файлів або місць, який використовується для різноманітних способів ''швидкого відкриття'' у '''KDevelop'''. Передбачено чотири версії цих способів:
** '''Quick open class''' (<menuchoice>Navigate -> Quick open class</menuchoice> or <keycap>Alt + Ctrl + C</keycap>): You will get a list of all classes in this session. Start typing (a part of) the name of a class and the list will continue to whittle down to only those that actually match what you've typed so far. If the list is short enough, select an element using the up and down keys and '''KDevelop''' will get you to the place where the class is declared.
** '''Швидко відкрити клас''' (<menuchoice>Навігація -> Швидко відкрити клас</menuchoice> або <keycap>Alt + Ctrl + C</keycap>): ви отримаєте список усіх класів у цьому сеансі. Почніть вводити (частину) назви класу, і у список скорочуватиметься до лише тих класів, у назвах яких міститься введений фрагмент тексту. Коли список стане достатньо коротким, виберіть у ньому запис за допомогою клавіш із стрілками вгору і вниз, і '''KDevelop''' перенесе вас до місця, де оголошено клас.
** '''Quick open function''' (<menuchoice>Navigate -> Quick open function</menuchoice> or <keycap>Alt + Ctrl + M</keycap>): You will get a list of all (member) functions that are part of the projects in the current session, and you can select from it in the same way as above. Note that this list may include both function declarations and definitions.
** '''Швидко відкрити функцію''' (<menuchoice>Навігація -> Швидко відкрити функцію</menuchoice> або <keycap>Alt + Ctrl + M</keycap>): ви отримаєте список усіх функцій (членів класів), які є частиною проєктів у поточному сеансі, і зможете вибрати потрібний запис у списку у спосіб, який описано вище. Зауважте, що до цього списку може бути включено і оголошення і визначення функцій.
** '''Quick open file''' (<menuchoice>Navigate -> Quick open file</menuchoice> or <keycap>Alt + Ctrl + O</keycap>): You will get a list of all files that are part of the projects in the current session, and you can select from it in the same way as above.
** '''Швидко відкрити файл''' (<menuchoice>Навігація -> Швидко відкрити файл</menuchoice> або <keycap>Alt + Ctrl + O</keycap>): ви отримаєте список усіх файлів, які є частиною проєктів поточного сеансу і зможете вибрати з нього пункт у спосіб, який описано вище.
** '''Universal quick open''' (<menuchoice>Navigate -> Quick open</menuchoice> or <keycap>Alt + Ctrl + Q</keycap>): If you forget which key combination is bound to which of the above commands, this is the universal swiss army knife — it simply presents you with a combined list of all files, functions, classes, and other things from which you can select.
** '''Універсальне швидке відкриття''' (<menuchoice>Навігація -> Швидко відкрити</menuchoice> або <keycap>Alt + Ctrl + Q</keycap>): якщо ви не пам'ятаєте, яку з комбінацій клавіш пов'язано із описаними вище командами, можете скористатися цим універсальним засобом — він просто покаже вам комбінований список усіх файлів, функцій, класів та інших записів, з яких ви можете вибрати потрібний.
* '''Jump to declaration/definition''': When implementing a (member) function, one often needs to switch back to the point where a function is declared, for example to keep the list of function arguments synchronised between declaration and definition, or to update the documentation. To do so, place the cursor onto the function name and select <menuchoice>Navigation -> Jump to declaration</menuchoice> (or hit <keycap>Ctrl + .</keycap>) to get to the place where the function is declared. There are multiple ways to get back to the original place:
* '''Перейти до оголошення/визначення''': при реалізації функції (члена класу) часто виникає потреба у зворотному переході до місця оголошення функції, наприклад, для підтримання синхронізації списку аргументів функції між оголошенням та визначенням або оновлення документації. Для здійснення подібних переходів розташуйте курсор на назві функції і виберіть пункт меню <menuchoice>Навігація -> Перейти до оголошення</menuchoice> (або натисніть комбінацію клавіш <keycap>Ctrl + .</keycap>), щоб перейти до місця оголошення функції. Існує декілька способів повернутися до початкового місця:
** Вибір пункту меню <menuchoice>Навігація -> Перейти до визначення</menuchoice> (або натискання комбінації клавіш <keycap>Ctrl + ,</keycap>).
** Selecting <menuchoice>Navigation -> Previous visited context</menuchoice> (or hit <keycap>Meta + Left</keycap>), as described below.
** Вибір пункту меню <menuchoice>Навігація -> Попередній відвіданий контекст</menuchoice> (або натисніть комбінацію клавіш <keycap>Meta + ←</keycap>), як це описано нижче.
{{Note|1=Jumping to the declaration of a symbol is something that does not only work when placing the cursor on the name of the function you are currently implementing. Rather, it also works for other symbols: Putting the cursor on a (local, global, or member) variable and jumping to its declaration also transports you to its location of declaration. Similarly, you can place the cursor on the name of a class, for example in a variable of function declaration, and jump to the location of its declaration.}}
{{Note_(uk)|1=Перехід до оголошення символу не обмежується лише функціями, які ви реалізуєте. Цей спосіб працює і у разі розташування курсора на назві (локальної, загальної чи вбудованої) змінної: вибір відповідного пункту меню призведе до пересування області перегляду до оголошення символу. Отже ви можете, наприклад, розташувати курсор на назві класу у оголошенні змінної функції і перейти до оголошення цього класу.}}
* '''Switch between declaration/definition''': In the example above, to jump to the site of the declaration of the current function, you need to first place the cursor on the function name. To avoid this step, you can select <menuchoice>Navigation -> Switch definition/declaration</menuchoice> (or hit <keycap>Shift + Ctrl + C</keycap>) to jump to the declaration of the function within which the cursor currently is. Selecting the same menu entry a second time transports you back to the place where the function is defined.
* '''Перемкнути визначення/оголошення''': у наведеному вище прикладі для переходу до місця оголошення поточної функції нам потрібно було спочатку розташувати курсор на назві функції. Якщо вам не хочеться цього робити, скористайтеся пунктом меню <menuchoice>Навігація -> Перемкнути визначення/оголошення</menuchoice> (або натисніть комбінацію клавіш <keycap>Shift + Ctrl + C</keycap>), щоб перейти до оголошення функції, у якій перебуває курсор. Повторний вибір цього пункту меню поверне курсор назад до визначення функції.
* '''Previous/Next use''': Placing the cursor on the name of a local variable and selecting <menuchoice>Navigation -> Next use</menuchoice> (or hitting <keycap>Meta + Shift + Right</keycap>) transports you to the next use of this variable in the code. (Note that this doesn't just search for the next occurrence of the variable name but in fact takes into account that variables with the same name but in different scopes are different.) The same works for the use of function names. Selecting <menuchoice>Navigation -> Previous use</menuchoice> (or hitting <keycap>Meta + Shift + Left</keycap>) transports you to the previous use of a symbol.
* '''Попереднє/Наступне використання''': якщо ви розташуєте курсор на назві локальної змінної і виберете пункт меню <menuchoice>Навігація -> Наступне використання</menuchoice> (або натиснете комбінацію клавіш <keycap>Meta + Shift + →</keycap>), програма перенесе вас до наступного використання цієї змінної у коді. (Зауважте, що при цьому не виконуватиметься простий пошук назви змінної, але враховуватиметься те, що змінні із тією самою назвою назвою, але у різних областях видимості є різними.) Те саме працює і для використань назв функцій. Вибір пункту меню <menuchoice>Навігація -> Попереднє використання</menuchoice> (або натискання комбінації клавіш <keycap>Meta + Shift + ←</keycap>) призведе до переходу до попереднього використання символу.
{{Note|1=To see the list of all uses of a name through which these commands cycle, place the cursor onto it and open the <menuchoice>Code Browser</menuchoice> tool view or press and hold the <keycap>Alt</keycap> button. This is explained in more detail in the section on [[Special:myLanguage/KDevelop5/Manual/Working_with_source_code#File_scope_information|Exploring code]].}}
{{Note_(uk)|1=Щоб переглянути список всіх використань назв, якими здійснюватиметься циклічний перехід внаслідок використання цієї команди, розташуйте курсор на назві символу і відкрийте панель <menuchoice>Перегляд коду</menuchoice> або натисніть і утримуйте клавішу <keycap>Alt</keycap>. Докладніше про використання цього прийому можна дізнатися з розділу щодо [[Special:myLanguage/KDevelop4/Manual/Working_with_source_code#File_scope_information|навігації кодом]].}}
* The '''context list''': Web browsers have this feature where you can go backward and forward in the list of most recently visited web pages. '''KDevelop''' has the same kind of features, except that instead of web pages you visit ''contexts''. A context is the current location of the cursor, and you change it by navigating away from it using anything but cursor commands — for example, by clicking on a location provided by a tooltip, in the <menuchoice>Code Browser</menuchoice> tool view, one of the options given in the <menuchoice>Navigation</menuchoice> menu, or any other navigation command. Using the <menuchoice>Navigation -> Previous Visited Context</menuchoice> (<keycap>Meta + Left</keycap>) and <menuchoice>Navigation -> Next Visited Context</menuchoice> (<keycap>Meta + Right</keycap>) transports you along this list of visited contexts just like the <menuchoice>back</menuchoice> and <menuchoice>forward</menuchoice> buttons of a browser transports you to the previous or next webpage in the list of visited pages. You can also use the code browser toolbar that gives you the option to click the left arrow to go backwards to a previous file and line number, or choose the down arrow that provides a pop-up list of previous files and line number to be chosen.[[Image:Kdevelop-context-history.png|525px|thumb|center]]
* '''Список контекстів''': у браузерах є можливість переходити назад і вперед списком нещодавно відвіданих сторінок. У '''KDevelop''' реалізовано подібні можливості, але замість переходу між сторінками ви переходите між ''контекстами''. Контекстом є поточне місце курсора. Ви можете змінити його переходом у будь-який спосіб, окрім команд пересування курсора, наприклад, клацанням на пункті місця на панелі підказки, на панелі інструментів <menuchoice>Навігація кодом</menuchoice>, на одному з пунктів у меню <menuchoice>Навігація</menuchoice> або використанням будь-якої іншої команди навігації. За допомогою пунктів меню <menuchoice>Навігація -> Попередній відвіданий контекст</menuchoice> (<keycap>Meta + ←</keycap>) і <menuchoice>Навігація -> Наступний відвіданий контекст</menuchoice> (<keycap>Meta + →</keycap>) ви можете переходити між пунктами у списку відвіданих контекстів так, як ви переходите між сторінками за допомогою кнопок <menuchoice>назад</menuchoice> і <menuchoice>вперед</menuchoice> у списку відвіданих сторінок у браузері. Крім того, ви можете скористатися панеллю інструментів браузера, де можна натиснути кнопку зі стрілкою ліворуч для переходу назад до попереднього файла і номера рядка, або натиснути кнопку зі стрілкою вниз, яка відкриває контекстний список попередніх відвіданих файлів та рядків.[[Image:Kdevelop-context-history.png|525px|thumb|center]]
* Finally, there are tool views that allow you to navigate to different places in your codebase. For example, the '''Classes''' tool provides you with a list of all namespaces and classes in all projects of the current session, and allows you to expand it to see member functions and variables of each of these classes: [[Image:Kdevelop-classes-view.png|525px|thumb|center]] Double-clicking on an item (or going through the context menu using the right mouse button) allows you to jump to the location of the declaration of the item. Other tools allow similar things; for example, the <menuchoice>Projects</menuchoice> tool view provides a list of files that are part of a session: [[Image:kdevelop-class-doc-tooltip.png|thumb|525px|center]]Again, double-clicking on a file opens it.
* Нарешті, передбачено панелі інструментів, за допомогою яких ви можете переходити до різних місць у програмному коді. Наприклад, на панелі '''Класи''' буде наведено список усіх просторів назв та класів в усіх проєктах поточного сеансу. У списку ви можете розгортати записи для перегляду функцій та змінних-членів кожного з цих класів: [[Image:Kdevelop-classes-view.png|525px|thumb|center]] Подвійним клацанням на записі (або використанням відповідного запису контекстного меню, яке можна викликати клацанням правою кнопкою миші) ви можете перейти до місця оголошення запису. Інші засоби надають змогу виконувати подібні ж речі. Наприклад, на панелі <menuchoice>Проєкти</menuchoice> буде показано писок файлів, які є частиною сеансу: [[Image:kdevelop-class-doc-tooltip.png|thumb|525px|center]]Знову ж таки, подвійне клацання на пункті файла призведе до його відкриття.
<span id="Writing source code"></span>
<span id="Writing source code"></span>
=== Writing source code ===
=== Введення коду ===
Because '''KDevelop''' understands your projects' source code, it can assist in writing more code. The following outlines some of the ways in which it does that.
Оскільки '''KDevelop''' «розуміє» код ваших проектів, це середовище може допомогти вам у написанні коду. Нижче наведено огляд деяких з цих допоміжних можливостей.
==== Auto-completion ====
==== Автозавершення ====
Probably the most useful of all features in writing new code is auto-completion. Consider, for example, the following piece of code:
Ймовірно, найкориснішою можливістю є можливість з автоматичного завершення фрагментів коду. Розглянемо, наприклад, такий фрагмент коду:
<!--}}-->{{Input|1=<nowiki>
<!--}}--><syntaxhighlight lang="cpp" line>
class Car {
class Car {
// ...
// ...
Line 184:
Line 182:
// ...do something with this variable...
// ...do something with this variable...
std::string color = my_ride.ge
std::string color = my_ride.ge
</nowiki>}}<!--{-->
</syntaxhighlight><!--{-->
In the last line, '''KDevelop''' will remember that the variable <code>my_ride</code> is of type <code>Car</code>, and will automatically offer to complete the name of the member function <code>ge</code> as <code>get_color</code>. In fact, all you have to do is to keep typing until the auto-completion feature has reduced the number of matches to one, and then hit the <keycap>Enter</keycap> key:
У останньому рядку '''KDevelop''' запам’ятає, що змінна <code>my_ride</code> належить до типу <code>Car</code> і буде автоматично пропонувати доповнення назви вбудованої функції <code>ge</code> у форматі <code>get_color</code>. Фактично, вам достатньо вводити назву, аж доки список знайдених відповідників не починатиметься з потрібного вам виразу, а потім натиснути клавішу <keycap>Enter</keycap>:
Note that you can click on the tool-tip to get more information about the function apart from its return type and whether it is public:
Зауважте, що ви можете клацнути на панелі підказки, щоб отримати більше даних щодо функції, окрім типу даних, які вона повертає, і те, чи є ця функція відкритою (public):
Auto-completion can save you a lot of typing if your project uses long variable and function names; furthermore, it avoids mis-spelling names (and the resulting compiler errors) and it makes it much simpler to remember the exact names of functions. For example, if all of your getters start with <code>get_</code>, then the auto-completion feature will be able to only present you a list of possible getters when you have typed the first four letters, likely reminding you in the process which of the functions is the correct one. Note that for auto-completion to work, neither the declaration of the <code>Car</code> class nor of the <code>my_ride</code> variable need to be in the same file as where you are currently writing code. '''KDevelop''' simply has to know that these classes and variables are connected, i.e. the files in which these connections are made need to be part of the project you are currently working on.
Автодоповнення може заощадити вам багато часу на введення тексту, якщо у вашому проєкті використовується багато довгих назв змінних та функцій. Крім того, так можна уникнути друкарських помилок у назвах (та помилок при компіляції, які є результатом таких помилок) і значно спростити запам'ятовування точних назв функцій. Наприклад, якщо усі назви функцій-отримувачів починаються із <code>get_</code>, можливість автодоповнення зможе показати список усіх можливих отримувачів, ввівши лише перші чотири літери, ймовірно, нагадавши вам, яку з функцій слід використати. Зауважте, що для забезпечення працездатності автодоповнення, ні оголошення класу <code>Car</code>, ні оголошення змінної <code>my_ride</code> не обов'язково мають зберігатися у тому самому файлі, у якому ви зараз пишете код. '''KDevelop''' достатньо значти, що ці класи і змінні поєднано, тобто файли, у яких виконано поєднання, мають бути частиною проєкту над якими ви зараз працюєте.
{{Note|1='''KDevelop''' doesn't always know when to assist you in completing code. If the auto-completion tooltip doesn't automatically open, hit <keycap>Ctrl + Space</keycap> to open a list of completions manually. In general, in order for auto-completion to work, '''KDevelop''' needs to parse your source files. This happens in the background for all files that are part of the projects of the current session after you start '''KDevelop''', as well as while after you stop typing for a fraction of a second (the delay can be configured).}}
{{Note_(uk)|1='''KDevelop''' не завжди може здогадатися, коли слід допомогти вам автоматичним доповненням коду. Якщо підказку автоматичного доповнення не було відкрито автоматично, натисніть комбінацію клавіш <keycap>Ctrl + Пробіл</keycap>, щоб відкрити список варіантів вручну. Загалом же, для того, щоб можна було скористатися автоматичним доповненням, '''KDevelop''' має обробити файли коду вашого проекту. Цю дію буде виконано у фоновому режимі для всіх файлів, які є частиною проектів поточного сеансу після запуску '''KDevelop''', а також після того, як ви припините вводити дані на частку секунди (тривалість паузи можна змінити).}}
{{Note|1='''KDevelop''' only parses files that it considers source code, as determined by the MIME-type of the file. This type isn't set before the first time a file is saved; consequently, creating a new file and starting to write code in it will not trigger parsing for auto-completion or code highlighting until after it is saved for the first time.}}
{{Note_(uk)|1='''KDevelop''' виконує обробку лише тих файлів, які є файлами коду програми, відповідно до типу MIME файла. Цей тип не встановлюється до першого збереження файла. Отже створення нового файла і введення коду до цього файла не увімкне автоматичної обробки файла для використання даних з метою автоматичного доповнення. Щоб увімкнути обробку, файл доведеться зберегти.}}
{{Note|1=As in the previous note, for auto-completion to work, '''KDevelop''' must be able to find declarations in header files. For this, it searches in a number of default paths. If it doesn't automatically find a header file, it will underline the name of a header file in red; in that case, right-click on it to tell '''KDevelop''' explicitly where to find these files and the information they provide.}}
{{Note_(uk)|1=Для того, щоб можна було скористатися автоматичним доповненням, '''KDevelop''' повинен мати доступ до файлів заголовків. Середовище виконає пошук цих файлів у декількох типових теках. Якщо файл заголовка не вдасться знайти автоматично, його пункт у списку буде підкреслено червоною лінією. У такому разі вам слід клацнути на цьому пункті правою кнопкою миші і повідомити '''KDevelop''' явним чином, де слід шукати цей файл та дані, які у ньому зберігаються.}}
{{Note|1=Configuring auto-completion is discussed in [[KDevelop5/Manual/Customizing_KDevelop#Customizing_code_auto-completion|this section of this manual]].}}
{{Note_(uk)|1=Налаштування автоматичного доповнення обговорено у [[KDevelop5/Manual/Customizing_KDevelop#Customizing_code_auto-completion|іншому розділі цього підручника]].}}
==== Adding new classes and implementing member functions ====
==== Додавання нових класів та реалізація вкладених функцій ====
'''KDevelop''' has an assistant for adding new classes. The procedure is described in [[Special:myLanguage/KDevelop5/Manual/Code generation with templates#Creating a new class|Creating a new class]]. A simple C++ class can be created by choosing the Basic C++ template from the <tt>Class</tt> category. In the assistant, we can choose some predefined member functions, for example, an empty constructor, a copy constructor and a destructor.
У '''KDevelop''' передбачено допоміжну програму для додавання нових класів. Її роботу описано у розділі [[Special:myLanguage/KDevelop5/Manual/Code generation with templates#Creating a new class|Створення класу]]. Простий клас C++ можна створити за допомогою основного шаблона C++ з категорії <tt>Клас</tt>. У допоміжній програмі ви можете вибрати попередні функції-елементи, наприклад порожній конструктор, конструктор копіювання та деструктор.
After completing the assistant, the new files are created and opened in the editor. The header file already has include guards and the new class has all the member functions we selected. The next two steps would be to document the class and its member functions and to implement them. We will discuss aids for documenting classes and functions below. To implement the special functions already added, simply go to the <menuchoice>bus.cpp</menuchoice> tab where the skeleton of functions is already provided:
Після завершення роботи допоміжної програми буде створено і відкрито у редакторі нові файли. Основу файла заголовків вже створено, а у новому класів є всі вибрані нами вбудовані функції. Наступними двома кроками мають бути документування класу та його вбудованих функцій та реалізація цих класів і функцій. Нижче ми обговоримо допоміжні засоби з документування класів і функцій. Щоб реалізувати спеціальні функції, які ми вже додали, просто перейдіть на вкладку <menuchoice>bus.cpp</menuchoice>, де вже є каркас наших функцій:
[[Image:Kdevelop-bus1.png|475px|thumb|center]]
[[Image:Kdevelop-bus1.png|475px|thumb|center]]
To add new member functions, go back to the <menuchoice>bus.h</menuchoice> tab and add the name of a function. For example, let us add this:
Щоб додати нові вкладені функції, поверніться на вкладку <menuchoice>bus.h</menuchoice> і додайте назву функції. Наприклад, можна додати таке:
[[File:Kdevelop-bus4.png|475px|thumb|center]]
[[File:Kdevelop-bus4.png|475px|thumb|center]]
Note how I have already started with the implementation. However, in many coding styles, the function shouldn't be implemented in the header file but rather in the corresponding .cpp file. To this end, locate the cursor on the name of the function and select <menuchoice>Code -> Move to source</menuchoice> or hit <keycap>Ctrl + Alt + S</keycap>. This removes the code between curly braces from the header file (and replaces it by a semicolon as necessary to terminate the function declaration) and moves it into the source file:
Зауважте, що реалізацію вже розпочато. Але у межах багатьох стилів програмування функції не слід реалізовувати у файлах заголовків, це слід робити у відповідних файлах .cpp. Для цього розташуйте курсор на назві функції і скористайтеся пунктом меню <menuchoice>Код -> Пересунути до коду</menuchoice> або натисніть комбінацію клавіш <keycap>Ctrl + Alt + S</keycap>. Код між фігурними дужками буде пересунуто з файла заголовків (його буде замінено на крапку з комою для завершення оголошення функції) до відповідного файла коду:
[[File:Kdevelop-bus3.png|475px|thumb|center]]
[[File:Kdevelop-bus3.png|475px|thumb|center]]
Note how I have just started typing and that I meant to imply that the <code>students</code> variable should probably be a member variable of class <code>Bus</code> but that I haven't yet added it. Note also how '''KDevelop''' underlines it to make clear that it doesn't know anything about the variable. But this problem can be solved: Clicking on the variable name yields the following tooltip:
Введення коду розпочато. Змінна <code>students</code> має, ймовірно, бути вбудованою змінною класу <code>Bus</code>, але її ще не додано до цього класу. '''KDevelop''' підкреслено цю змінну, щоб позначити те, що середовищу ще нічого не відомо про цю змінну. Цю проблему просто розв’язати: натискання назви змінної відкриє таку панель підказки:
[[File:Kdevelop-bus6.png|475px|thumb|center]]
[[File:Kdevelop-bus6.png|475px|thumb|center]]
As a final point: The method using <menuchoice>Code -> Move to source</menuchoice> does not always insert the new member function where you may want it. For example, you may want it to be marked as <code>inline</code> and place it at the bottom of the header file. In a case like this, write the declaration and the start writing the definition of the function like this:
Нарешті, метод використання пункту меню <menuchoice>Код -> Пересунути до коду</menuchoice> не завжди призводить до вставляння вбудованої функції до бажаного місця у коді. Наприклад, вам може бути потрібним визначення коду як <code>inline</code> і розташування його у нижній частині файла заголовків. У такому разі вкажіть оголошення і почніть введення визначення функції ось так:
Good code is well documented, both at the level of the implementation of algorithms within in functions as well as at the level of the interface — i.e., classes, (member and global) functions, and (member or global) variables need to be documented to explain their intent, possible values of arguments, pre- and postconditions, etc. As far as documenting the interface is concerned, [http://www.doxygen.org doxygen] has become the de facto standard for formatting comments that can then be extracted and displayed on searchable webpages.
Хороший код завжди добре документовано, як на рівні реалізації алгоритмів у функціях, так і на рівні інтерфейсу, — тобто класи (вбудовані і загальні) функції та (вбудовані і загальні) змінні слід документувати, щоб всім було зрозумілим їхнє призначення, можливі значення аргументів, попередні та остаточні умови тощо. У документуванні інтерфейсів фактичним стандартом є формат коментарів [http://www.doxygen.org doxygen], дані його можна видобути і показати на придатних для пошуку інтернет-сторінках.
'''KDevelop''' supports this style of comments by providing a short cut to generate the framework of comments that document a class or member function. For example, assume you have already written this code:
У '''KDevelop''' передбачено підтримку коментарів у цьому форматі за допомогою скорочення для створення оболонки-коментаря, який документуватиме клас або вбудовану функцію. Наприклад, припустімо ви вже створили такий код:
{{Input|1=<nowiki>
<syntaxhighlight lang="cpp" line>
class Car {
class Car {
public:
public:
std::string get_color () const;
std::string get_color () const;
};
};
</nowiki>}}
</syntaxhighlight>
You now want to add documentation to both the class and the member function. To this end, move the cursor onto the first line and select <menuchoice>Code -> Document Declaration</menuchoice> or hit <keycap>Alt + Shift + D</keycap>. '''KDevelop''' will respond with the following:
Тепер нехай вам потрібно додати документацію для класу і вбудованої функції. Для цього пересуньте курсор на перший рядок коду і скористайтеся пунктом меню <menuchoice>Код -> Документувати оголошення</menuchoice> або натисніть комбінацію клавіш <keycap>Alt + Shift + D</keycap>. '''KDevelop''' відкриє таке діалогове вікно:
The cursor is already in the grayed out area for you to fill in the short description (after the doxygen keyword <code>@brief</code>) of this class. You can then continue to add documentation to this comment that gives a more detailed overview of what the class does:
Курсор вже перебуває у затіненій області, щоб ви могли ввести короткий опис (після ключового слова doxygen <code>@brief</code>) цього класу. Тепер ви можете продовжити додавати документацію до цього коментаря, який краще пояснюватиме призначення класу:
When you get to the end of a line, hit <keycap>Enter</keycap> and '''KDevelop''' will automatically start a new line that starts with an asterisk and indent the cursor by one character. After documenting an item and <keycap>Enter</keycap> is hit outside of the documentation area, the gray highlight is removed.
Коли ви дістанетеся кінця рядка, натисніть <keycap>Enter</keycap>, і '''KDevelop''' автоматично розпочне новий рядок, який починатиметься із зірочки, і відступить курсором на один символ. По завершенню документування запису і натискання <keycap>Enter</keycap> поза областю документування, сіре підсвічування буде вилучено.
Now let's document the member function, again by putting the cursor on the line of the declaration and selecting <menuchoice>Code -> Document Declaration</menuchoice> or hitting <keycap>Alt + Shift + D</keycap>:
Тепер виконаємо документування вбудованої функції. Знову розташуйте курсор на рядку оголошення і виберіть пункт меню <menuchoice>Код -> Документувати оголошення</menuchoice> або натисніть комбінацію клавіш <keycap>Alt + Shift + D</keycap>:
Again, '''KDevelop''' automatically generates the skeleton of comment, including documentation for the function itself, as well as its return type. In the current case, the name of the function is pretty much self-explanatory, but oftentimes function arguments may not be and should be documented individually. To illustrate this, let's consider a slightly more interesting function and the comment '''KDevelop''' automatically generates:
Знову ж таки, '''KDevelop''' автоматично створить каркас коментаря разом з документації щодо самої функції, а також типом даних, які вона повертає. У нашому випадку назва функції доволі очевидно описує її призначення, але часто аргументи функції можуть бути доволі неочевидними, їх слід документувати окремо. Наприклад, розгяньмо трохи цікавішу функцію та коментар, який автоматично створить для неї '''KDevelop''':
Here, the suggested comment already contains all the Doxygen fields for the individual parameters, for example.
У нашому прикладі у запропонованому коментарі вже містяться всі поля Doxygen для окремих параметрів.
==== Renaming variables, functions and classes ====
==== Перейменування змінних, функцій і класів ====
Sometimes, one wants to rename a function, class or variable. For example, let's say we already have this:
Іноді виникає потреба у перейменуванні функції, класу або змінної. Наприклад, нехай маємо такий код:
[[Image:kdevelop-38.png|thumb|550px|center]]
[[Image:kdevelop-38.png|thumb|550px|center]]
We then realize that we're unhappy with the name <code>remove_students</code> and would have rather called it, say, <code>throw_out_students</code>. We could do a search-replace for the name, but this has two drawbacks:
Нехай пізніше ми зрозуміємо, що назва <code>remove_students</code> є невдалою, і її варто назвати, скажімо, <code>throw_out_students</code>. Ви могли б виконати пошук з заміною назви функції, але у такого способу є два недоліки:
* The function may be used in more than one file.
* Функцію може бути використано у декількох файлах.
* We really only want to rename this function and not touch functions that may have the same name but are declared in other classes or namespaces.
* Нам потрібно перейменувати лише цю функцію і не чіпати функції, які можуть мати ту саму назву, але які оголошено у інших класах або просторах назв.
Both these problems can be solved by moving the cursor on any of the occurrences of the name of the function and selecting <menuchoice>Code -> Rename declaration</menuchoice> (or right-clicking on the name and selecting <menuchoice>Rename Bus::remove_students</menuchoice>). This brings up a dialog box where you can enter the new name of the function and where you can also see all the places where the function is actually used:
Обидві ці проблеми можна розв’язати наведенням курсора на всі використання назви функції з наступним вибором пункту <menuchoice>Код -> Перейменувати оголошення</menuchoice> (або клацанням правою кнопкою миші на назві з вибором пункту <menuchoice>Перейменувати Bus::remove_students</menuchoice>). У відповідь буде відкрито діалогове вікно, за допомогою якого ви зможете ввести нову назву функції і переглянути всі місця, де використано функцію:
[[Image:kdevelop-39.png|thumb|550px|center]]
[[Image:kdevelop-39.png|thumb|550px|center]]
==== Code snippets ====
==== Фрагменти коду ====
Most projects have pieces of code that one frequently has to write in source code. Examples are: for compiler writers, a loop over all instructions; for user interface writers, checks that user input is valid and if not to open an error box; in the project of the author of these lines, it would be code of the kind
У більшості проектів зустрічаються фрагменти коду, які доводиться використовувати доволі часто. Приклади: інструкції компілятора, цикл для всіх інструкцій, для функцій запису інтерфейсу користувача перевірки введених користувачем даних без відкриття вікна повідомлення про помилку. У проекті автора цього підручника часто використовується такий різновид коду:
{{Input|1=<nowiki>
<syntaxhighlight lang="cpp" line>
for (typename Triangulation<dim,spacedim>::active_cell_iterator;
for (typename Triangulation<dim,spacedim>::active_cell_iterator;
cell = triangulation.begin_active();
cell = triangulation.begin_active();
cell != triangulation.end(); ++cell)
cell != triangulation.end(); ++cell)
... do something with the cell ...
... Робимо щось із cell ...
</nowiki>}}
</syntaxhighlight>
Rather than typing this kind of text over and over again (with all the concomitant typos one introduces), the <menuchoice>Snippets</menuchoice> tool of '''KDevelop''' can help here. To this end, open the tool view (see [[Special:myLanguage/KDevelop5/Manual/Working with source code#Tools and views|Tools and views]] if the corresponding button isn't already on the perimeter of your window). Or, go to <menuchoice>Window -> Tool views</menuchoice> in the top menubar, and turn on <menuchoice>Snippets</menuchoice>. Then click on the <menuchoice>Add repository</menuchoice>button (a slight misnomer — it allows you to create a named collection of snippets for source codes of a particular kind, e.g. C++ sources) and create an empty repository. Then click <menuchoice>Add Snippet</menuchoice> to add a snippet, to get a dialog like the following:
Замість введення тексту подібного типу знову і знову (із усіма можливими друкарськими помилками), ви можете скористатися інструментом '''KDevelop''' <menuchoice>Фрагменти</menuchoice>. Для цього відкрийте панель інструментів (див. [[Special:myLanguage/KDevelop5/Manual/Working with source code#Tools and views|Інструменти і панелі перегляду]], якщо відповідної кнопки ще немає на периметрі вашого вікна). Крім того, ви можете скористатися пунктом <menuchoice>Вікно -> Панелі інструментів</menuchoice> на верхній панелі меню і увімкнути <menuchoice>Фрагменти</menuchoice>. Далі, натисніть кнопку <menuchoice>Додати сховище</menuchoice> (дещо оманлива назва — за допомогою цього пункту можна створити іменовану збірку фрагментів для початкових кодів певного типу, наприклад, коду C++) і створіть порожнє сховище. Потім натисніть <menuchoice>Додати фрагмент</menuchoice>, щоб додати фрагмент і відкрити діалогове вікно, подібне до такого:
[[Image:Kdevelop-snippet.png|475px|thumb|center]]
[[Image:Kdevelop-snippet.png|475px|thumb|center]]
If no snippet repository has been created yet and your project is based on C++, Using the menu choice <menuchoice>Tools -> Create Snippet</menuchoice> creates a repository named ''ISO C++ snippets'' and puts your snippets in it as shown above. To the right of the ''Create Snippet'' dialog box is a view of the snippets tool view showing the snippets available for use.
Якщо сховища із фрагментами ще не було створено, і ваш проєкт засновано на C++, використання пункту меню <menuchoice>Інструменти -> Створити фрагмент</menuchoice> призводить до створення сховища із назвою ''Фрагменти ISO C++'' і записування ваших фрагментів до сховища, як це показано вище. Праворуч у діалоговому вікні ''Створення фрагмента'' розташовано панель перегляду, на якій показано фрагменти, якими можна скористатися.
{{Note|1=The name of a snippet may not have spaces or other special characters because it must look like a normal function or variable name (for reasons that will become clear in the next paragraph). }}
{{Note_uk|1=У назві фрагмента не повинно міститися пробілів або інших спеціальних символів, оскільки вона має бути подібною до звичайної назви функції або змінної (з причин, які буде висвітлено у наступному абзаці). }}
To use a snippet already defined when you are editing code, just type the name of the snippet like you would any other function or variable name. This name will become available for auto-completion — which means that there is no harm in using a long and descriptive name for a snippet such as the one above — and when you accept the suggestion of the auto-completion tooltip (for example by just hitting <keycap>Enter</keycap>), the already entered part of the snippets' name will be replaced by the full expansion of the snippet and will be properly indented:
Щоб скористатися таким чином визначеним фрагментом, вам слід просто почати вводити у коді його назву, як ви це робите для будь-яких інших функцій або змінних. Для введених літер буде відкрито панель автоматичного доповнення (це означає, що можна використовувати будь-які достатньо довгі для розрізнення назви фрагментів, зокрема назви, подібні до використаної нами), якщо ви виберете відповідний пункт фрагмента на панелі підказки автоматичного доповнення (наприклад, натисканням клавіші <keycap>Enter</keycap>), вже введену частину назви фрагмента буде замінено повним текстом фрагмента з відповідними відступами:
Note that for this to work, the <menuchoice>Snippets</menuchoice> tool view need not be open or visible. An alternative way to insert a snippet is to simply click on it in the snippet tool view. By hovering the mouse over the snippet, it gives you a view of the code in the snippet.
Зауважте, що, щоб це спрацювало, слід відкрити або зробити видимою панель інструментів <menuchoice>Фрагменти</menuchoice>. Альтернативним способом вставлення фрагмента є просте клацання на ньому на панелі інструментів фрагментів. Якщо навести вказівник миші на фрагмент, програма покаже вам панель перегляду коду фрагмента.
{{Note|1=Snippets are much more powerful than just explained. For a full description of what you can do with them, see the [[Special:myLanguage/KDevelop5/Manual/Tool_list/Snippets|detailed documentation of the Snippets tool]].}}<span id="Modes and working sets"></span>
{{Note_(uk)|1=Фрагменти є набагато потужнішими, ніж було пояснено. Повний опис можливостей, які вони надають, ознайомтеся з [[Special:myLanguage/KDevelop5/Manual/Tool_list/Snippets|докладною документацією з інструмента «Фрагменти»]].}}<span id="Modes and working sets"></span>
If you've gotten this far, take a look at the upper right of the '''KDevelop''' main window you will see a code button. When the button is pushed, you will see that there are two '''options''' offered: <menuchoice>Commit Current Project...</menuchoice> (see [[Special:myLanguage/KDevelop5/Manual/Working with version control systems|Working with version control systems]]) and <menuchoice>Debug</menuchoice> (see [[Special:myLanguage/KDevelop5/Manual/Debugging programs|Debugging programs]]).
Якщо ви вже дісталися так далеко, зверніть увагу на верхній правий кут головного вікна '''KDevelop''' — ви побачити кнопку коду. Якщо натиснути цю кнопку, програма запропонує два '''варіанти''' дій: <menuchoice>Внести поточний проєкт...</menuchoice> (див. [[Special:myLanguage/KDevelop5/Manual/Working with version control systems|робота із системами керування версіями]]) та <menuchoice>Діагностика</menuchoice> (див. [[Special:myLanguage/KDevelop5/Manual/Debugging programs|діагностування вад у програмах]]).
Each mode has its own set of tools that are stacked around the perimeter, and each mode also has a ''working set'' of currently open files and documents. Furthermore, each such working set is associated with a current session, i.e. we have the relationship shown above. Note that the files in the working set come from the same session, but they may come from different projects that are part of the same session.
Для кожного з режимів передбачено власний набір інструментів, кнопки яких розташовано вздовж периметра вікна середовища, для кожного режиму передбачено власний ''робочий набір'' відкритих файлів і документів. Крім того, кожен такий робочий набір пов’язано з поточним сеансом, тобто маємо взаємозв’язок, подібний до показаного вище. Зауважте, що файли у робочому наборі є частиною одного сеансу, але можуть належати до різних проектів, які є частинами цього сеансу.
If you open '''KDevelop''' the first time, the working set is empty — there are no open files. But as you open files for editing (or debugging, or reviewing in the other modes) your working set grows. You will notice that whenever you close '''KDevelop''' and later start it again, the working set is saved and restored, i.e. you get the same set of open files.
Якщо ви відкрили вікно '''KDevelop''' вперше, робочий набір буде порожнім, — ще не відкрито жодного файла. Але з відкриттям файлів для редагування (або діагностики, перегляду у інших режимах) ваш робочий набір розширюватиметься. Кожного разу, коли ви завершуватимете роботу '''KDevelop''', а потім починатимете її знову, робочий набір буде зберігатися і відновлюватися, тобто ви працюватимете з одним набором відкритих файлів.
If you hover your mouse over the symbol for the working set, you get a tooltip that shows you which files are currently open in this working set (here: the <code>helper.h</code>, <code>helper.cpp</code>, <code>filemanagerlistjob.h</code> and <code>filemanagerlistjob.cpp</code> files). The working set icon can have different colors at different times in it, but they have no specific meaning. Clicking on the square with a minus sign closes the tab for the corresponding file in the working set. The point about closing a working set, however, is that it doesn't just close all files, it actually prompts you to save the file if any are changed but not saved and opens a new, still empty one.<span id="Some useful keyboard shortcuts"></span>
Якщо ви наведете вказівник миші на символ для робочого набору, програма покаже панель підказки зі списком файлів, які відкрито у цьому робочому наборі (у нашому прикладі це файли <code>helper.h</code>, <code>helper.cpp</code>, <code>filemanagerlistjob.h</code> та <code>filemanagerlistjob.cpp</code>). Піктограма робочого набору може мати різні кольори у різний час, але ці кольори не мають певного значення. Клацання на квадраті зі знаком «мінус» закриє вкладку для відповідного файла у робочому наборі. Суть роботи пункту закриття робочого набору полягає у тому, що його вибір не лише закриває усі файли, але і просить вас зберегти усі файли, до яких внесено зміни, але які не збережено, і відкриває новий порожній набір.<span id="Some useful keyboard shortcuts"></span>
=== Some useful keyboard shortcuts ===
=== Деякі корисні клавіатурні скорочення ===
'''KDevelop's''' editor follows the standard keyboard shortcuts for all usual editing operations, that can be configured as you desire.
У редакторі '''KDevelop''' використано стандартні клавіатурні скорочення для звичайних дій з редагування. Ці скорочення можна змінити, якщо у вас виникне така потреба.
There is an option to configure and save different shortcut schemes, where you can also export or import any of your schemes.
Передбачено пункт для налаштовування і зберігання різних схем клавіатурних скорочень. За допомогою відповідного вікна ви можете експортувати та імпортувати будь-які ваші схеми.
However, it also supports a number of more advanced operations when editing source code, some of which are bound to particular key combinations. The following are frequently particularly helpful:
Втім, передбачено також підтримку декількох додаткових дій при редагуванні початкового коду. Деякі з цих дій пов'язано із натисканням певних комбінацій клавіш. Зокрема, часто є зручними такі комбінації:
{| border="1" cellspacing="0"
{| class="wikitable"
!colspan="2" style="background-color:#ffff99;" | Jumping around in code
!colspan="2"| Пересування кодом
|-
|-
| <keycap>Ctrl+Alt+O</keycap>
| <keycap>Ctrl+Alt+O</keycap>
| Quick open file: enter part of a filename and select among all the files in the current session's projects' directory trees that match the string; the file will then be opened
| Пришвидшене відкриття файла: вкажіть частину назви файла і виберіть той з них у каталозі проектів поточного сеансу, який вам потрібен; цей файл і буде відкрито.
|-
|-
| <keycap>Ctrl+Alt+C</keycap>
| <keycap>Ctrl+Alt+C</keycap>
| Quick open class: enter part of a class name and select among all class names that match; the cursor will then jump to the class declaration
| Пришвидшене відкриття класу: вкажіть частину назви класу і виберіть ту з назв класів, яка вам потрібна; курсор буде переведено до рядка оголошення класу.
|-
|-
| <keycap>Ctrl+Alt+M</keycap>
| <keycap>Ctrl+Alt+M</keycap>
| Quick open function: enter part of a (member) function name and select among all names that match; note that the list shows both declarations and definitions and the cursor will then jump to the selected item
| Пришвидшене відкриття функції: вкажіть частину назви функції (частини класу) і виберіть з запропонованих варіантів той, який вам потрібен; зауважте, що у списку буде показано оголошення і визначення, а курсор буде переведено до вибраного вами пункту.
|-
|-
| <keycap>Ctrl+Alt+Q</keycap>
| <keycap>Ctrl+Alt+Q</keycap>
| Universal quick open: type anything (file name, class name, function name) and get a list of anything that matches to select from
| Універсальне пришвидшення відкриття: вкажіть будь-які дані (назву файла, назву класу, назву функції), і вам буде показано список всіх частин проекту, які відповідають критерію пошуку.
|-
|-
| <keycap>Ctrl+Alt+N</keycap>
| <keycap>Ctrl+Alt+N</keycap>
| Outline: Provide a list of all things that are happening in this file, e.g. class declarations and function definitions
| Огляд: показує список всіх дій, які виконуються у файлі, наприклад, оголошень класів та визначень функцій.
|-
|-
| <keycap>Ctrl+,</keycap>
| <keycap>Ctrl+,</keycap>
| Jump to definition of a function if the cursor is currently on a function declaration
| Перейти до визначення функції, якщо курсор перебуває у місці її оголошення.
|-
|-
| <keycap>Ctrl+.</keycap>
| <keycap>Ctrl+.</keycap>
| Jump to declaration of a function or variable if the cursor is currently in a function definition
| Перейти до оголошення функції або змінної, якщо курсор перебуває у позиції визначення функції.
|-
|-
| <keycap>Ctrl+Alt+PageDown</keycap>
| <keycap>Ctrl+Alt+PageDown</keycap>
| Jump to next function
| Перейти до наступної функції
|-
|-
| <keycap>Ctrl+Alt+PageUp</keycap>
| <keycap>Ctrl+Alt+PageUp</keycap>
| Jump to previous function
| Перейти до попередньої функції
|-
|-
| <keycap>Ctrl+G</keycap>
| <keycap>Ctrl+G</keycap>
| Goto line
| Перейти до рядка
|-
|-
!colspan="2" style="background-color:#ffff99;" | Searching and replacing
!colspan="2"| Пошук і заміна
|-
|-
| <keycap>Ctrl+F</keycap>
| <keycap>Ctrl+F</keycap>
| Find
| Знайти
|-
|-
| <keycap>F3</keycap>
| <keycap>F3</keycap>
| Find next
| Знайти далі
|-
|-
| <keycap>Ctrl+R</keycap>
| <keycap>Ctrl+R</keycap>
| Replace
| Замінити
|-
|-
| <keycap>Ctrl+Alt+F</keycap>
| <keycap>Ctrl+Alt+F</keycap>
| Find-Replace in multiple files
| Знайти і замінити у декількох файлах
|-
|-
!colspan="2" style="background-color:#ffff99;" | Other things
!colspan="2" | Інші команди
|-
|-
| <keycap>Ctrl+_</keycap>
| <keycap>Ctrl+_</keycap>
| Collapse one level: remove this block from view, for example if you want to focus on the bigger picture within a function
| Згорнути один рівень: вилучити блок з перегляду, наприклад, якщо ви бажаєте зосередитися на загальнішій картині у функції.
|-
|-
| <keycap>Ctrl++</keycap>
| <keycap>Ctrl++</keycap>
| Expand one level: undo the collapsing
| Розгорнути один рівень: скасувати згортання.
|-
|-
| <keycap>Ctrl+D</keycap>
| <keycap>Ctrl+D</keycap>
| Comment out selected text or current line
| Зняти коментування з позначеного фрагмента тексту або поточного рядка.
|-
|-
| <keycap>Ctrl+Shift+D</keycap>
| <keycap>Ctrl+Shift+D</keycap>
| Comment in selected text or current line
| Додати позначки коментаря до позначеного тексту або поточного рядка.
|-
|-
| <keycap>Alt+Shift+D</keycap>
| <keycap>Alt+Shift+D</keycap>
| Document the current function. If the cursor is on a function or class declaration then hitting this key will create a doxygen-style comment pre-populated with a listing of all parameters, return values, etc.
| Документувати поточну функцію. Якщо курсор перебуває на оголошенні функції або класу, натискання цієї комбінації клавіш призведе до створення коментаря у форматі doxygen зі списком параметрів, значень, які повертаються, тощо.
|-
|-
| <keycap>Ctrl+T</keycap>
| <keycap>Ctrl+T</keycap>
| Transpose the current and the previous character
| Поміняти місцями поточний і попередній символи
|-
|-
| <keycap>Ctrl+K</keycap>
| <keycap>Ctrl+K</keycap>
| Delete the current line (note: this is not just emacs' "delete from here to the end of the line")
| Вилучити поточний рядок (зауваження: ця дія не збігається за результатом з дією «вилучити звідси до кінця рядка» у emacs)
Окрім зневаджування, читання та написання коду є найважливішими завданнями під час розробки програмного забезпечення. З метою полегшення навігації кодом та його написання у KDevelop передбачено багато різних інструментів. Як буде докладніше показано у наступних розділах, KDevelop не просто редактор коду, — це скоріше система керування кодом, яка може подавати різні дані, отримані на основі аналізу загальної сукупності коду всього вашого сеансу роботи.
Інструменти та панелі перегляду
Для роботи з проектами у KDevelop передбачено інструменти. Інструмент надає певні дані щодо коду або виконує з ним певну дію. Інструментам відповідають кнопки вздовж периметра вікна програми (з вертикальним текстом на полях ліворуч і праворуч та горизонтальним вздовж нижнього поля). Якщо ви натиснете таку кнопку, у головному вікні буде відкрито підвікно — панель перегляду; якщо кнопку буде натиснуто ще раз, відповідне підвікно буде закрито.
Зауваження
Щоб закрити підлегле вікно, ви можете просто натиснути кнопку зі значком x у верхньому правому куті (або у верхньому лівому куті для інструментів на нижньому полі) цього допоміжного вікна.
На наведеному вище зображенні ви можете бачити певний набір інструментів, вирівняних за лівим і правим полем. Ліворуч відкрито панель інструмента Класи, праворуч — Фрагменти. Посередині можна бачити панель редактора. З практичних міркувань, переважну частину часу розробки варто працювати лише з редактором та панеллю Класи чи Перегляд коду, відкритою ліворуч. На час використання певного інструмента можна відкрити його панель, яку після використання варто закрити з метою збільшення простору для панелі редактора.
Після першого запуску KDevelop ви вже зможете скористатися кнопкою інструмента Проєкти. Натисніть цю кнопку: у відповідь буде відкрито панель зі списком проєктів, які було додано до сеансу у нижній частині вікна та панель перегляду файлової системи вашого проєкту у верхній його частині.
У KDevelop ви можете скористатися багатьма іншими інструментами, не всі з них представлено кнопками вздовж периметра вікна у початковому стані. Щоб додати кнопку, скористайтеся пунктом меню Вікна -> Додати панель інструмента. У результаті буде відкрито вікно для вибору бажаної панелі. У контекстному вікні ви зможете натискати кнопки ліворуч, вниз, праворуч для пересування панелей і вибору місця розташування панелей. Ось перелік можливих корисних інструментів:
Класи: повний список всіх класів, які визначено у одному з проектів або у вашому сеансі з усіма вбудованими функціями та змінними. Натискання пункту елемента класу відкриє вікно редактора з місцем оголошення елемента, пункт якого було натиснуто.
Документи: тут буде показано список поточних відкритих у редакторі файлів.
Перегляд коду: залежно від розташування курсора у редакторі файла, на цій панелі буде показано пов’язані з кодом дані. Наприклад, якщо курсор перебуває у рядку з #include, на панелі буде показано дані щодо файла, який включено до коду, зокрема дані щодо оголошених у файлі класів. Якщо курсор перебуває на порожньому рядку у файлі, на панелі буде показано класи і функції, оголошені і визначені у поточному файлі (всі як посилання: натискання відповідного пункту відкриватиме файл з оголошенням або визначенням класу чи функції). Якщо курсор перебуває на визначенні функції, на панелі буде показано місце оголошення та список місць, у яких використано функцію.
Файлова система: показує ієрархічну структуру файлової системи.
Документація: надає вам змогу виконувати пошук даних на сторінках довідника (man) та у інших довідкових документах, зокрема документації до C++, Qt, PHP тощо.
Фрагменти: на цій панелі буде наведено фрагменти тексту, які використовують вами регулярно, і які ви не хочете повторно вводити кожного разу. У прикладі, на основі якого було створено знімок екрана, була потреба часто використовувати фрагмент коду
Цей вираз завжди використовуватиметься у такій формі кожного разу — чудовий кандидат на включення до списку фрагментів.
Konsole: відкриває панель командного рядка у головному вікні KDevelop, щоб ви могли віддати потрібну вам команду оболонки (наприклад, виконати ./configure).
Для багатьох програмістів найважливішою є економія вертикального місця на екрані. Щоб досягти такої економії, ви можете розташувати панелі інструментів вздовж лівої та правої межі вікна програми. Щоб пересунути панель, клацніть на заголовку правою кнопкою миші і виберіть нове її розташування.
Огляд роботи з кодом
Локальні дані
KDevelopрозуміє код програми, тому це середовище може надавати вам дані щодо змінних або функцій вашої програми. Наприклад, у цьому підручнику наведено знімок роботи з фрагментом коду, де вказівник миші наведено на символ cell у рядку 1316 (якщо ви надаєте перевагу роботі за допомогою клавіатури, того самого ефекту можна досягти утримуванням певний час натиснутою клавіші Alt):
KDevelop показує підказку, зокрема тип змінної (тут: container), де цю змінну оголошено (контейнер, яким тут є функція-обгортка operator()(AreaIndex *index), оскільки це локальна змінна), тип даних (змінна, не функція, клас або простір назв) та місце оголошення (у рядку 376, декількома рядками коду вище).
У поточному контексті з символом, на який наведено вказівник миші, не пов’язано жодної документації. У нашому прикладі, де вказівник миші наведено на символ Container у рядку 376, буде показано такі дані:
Тут KDevelop показано оголошення зі стороннього файла (container.h, який є частиною зовсім іншого проекту того самого сеансу) разом з коментарем у форматі doxygen, який супроводжує цей оголошення.
Кориснішими ці підказки робить те, що вони є динамічними: ви можете клацнути на пункті контейнера, щоб отримати відомості щодо контексту, у якому оголошено змінну (тобто щодо простору назв Sublime, зокрема того, де її оголошено, визначено, використано або якою є її документація), і ви можете клацнути на розфарбованих у синє посилань для перенесення позиції курсора до місця оголошення символу (наприклад, у container.h, рядок 40) або отримання списку місць, де цей символ використано у поточному файлі або в усіх проєктах поточного сеансу. Останній варіант часто корисним, якщо ви хочете вивчити те, як, наприклад, певну функцію використано у великій кодовій базі.
Зауваження
Панель підказки з часом зникатиме: щоб її знову відкрити доведеться знов утримувати натиснутою клавішу Alt або наводити вказівник миші на фрагменти коду. Якщо вам потрібно зафіксувати дані з цієї панелі, відкрийте панель інструмента Перегляд коду. У нашому прикладі курсор перебуває у тій самій функції, що і раніше, а на панелі інструмента ліворуч показано той самий набір даних, що і на панелі підказки раніше:
Пересування курсора у правій частині вікна призводитиме до зміни даних у його лівій частині. Натискання кнопки Заблокувати поточний перегляд у верхній правій частині надасть вам змогу зафіксувати дані, убезпечивши їх від зміни розташування курсора на час перегляду.
Зауваження
Доступ до контекстних даних такого типу можна отримати з багатьох частин KDevelop, не лише з панелі редактора коду. Наприклад, утримування натиснутою клавіші Alt у списку автоматичного доповнення (наприклад, під час пришвидшеного відкриття якогось файла) також призводитиме до показу контекстних даних щодо поточного рядка.
Дані щодо окремих файлів
Наступним рівнем є отримання даних щодо всього файла коду, над яким ви працюєте. Щоб переглянути її, розташуйте курсор на початку поточного файла і подивіться на дані, які буде показано на панелі інструмента Перегляд коду:
Тут середовищем показано список просторів назв, класів та функцій, оголошених або визначених у поточному файлі. За допомогою цього списку ви можете ознайомитися з загальними даними щодо дій, які виконуються у файлі, та безпосередньо перейти до будь-якого з оголошень або визначень без потреби у гортанні коду файла або пошуку певного фрагмента.
Дані щодо проектів та сеансів
Існує багато способів отримати загальні дані щодо проекту (або, фактично, всіх проектів сеансу). Такі дані, зазвичай, можна знайти на панелях перегляду різноманітних інструментів середовища. Наприклад, на панелі інструмента Класи показано ієрархічну структуру всіх класів і зовнішніх просторів назв для всіх проектів сеансу, разом з вбудованими функціями та змінними кожного з цих класів:
Знову ж таки, за допомогою наведення вказівника миші на запис у списку можна отримати дані щодо відповідного символу, розташування його оголошення та визначення і випадків використання. Подвійним клацанням на пункті цього ієрархічного списку можна відкрити вікно редактора на позиції, де оголошено або визначено символ.
Але існують інші способи вивчення загальних відомостей. Наприклад, інструмент Документи надає панель перегляду документів, які відкрито, і надає можливість вибору одного з документів для перегляду і безпроблемного пересування від одного документа до іншого:
Ви також можете вибрати пункт із маленькою коробкою із чотирма кубиками у верхньому правому куті, щоб отримати список відкритих файлів, який має назву робочий набір. Кожен рядок починається з поля для позначки, позначення якого вилучає файл з робочого списку. Також буде показано кнопку у правій частині, натискання якої надає вам змогу виконати записування до реєстру git. Корисно, якщо вам потрібно перейти до іншої гілки або до повністю іншого проєкту.
Пояснення щодо розфарбовування коду
KDevelop використовує різноманітні кольори для підсвічування різних об'єктів у початковому коді. Якщо ви знаєте призначення різних кольорів, ви можете швидко отримати багато інформації з початкового коду простим його переглядом (за кольорами) навіть не читаючи сам код. Правила підсвічування такі:
Для об'єктів типів Class / Struct, Enum (значень і типу), (загальних) функцій і членів класу визначено власні кольори (класи — зелені, переліки — темно-червоні, а учасники — темно-жовті або фіолетові, (загальні) функції — завжди фіолетові).
Усі загальні змінні буде розфарбовано у темно-зелений.
Ідентифікатори, які є визначеннями типів для інших типів буде розфарбовано у синьо-зелений колір.
Усі оголошення та визначення об'єктів буде показано напівжирним шрифтом.
Якщо доступ до учасника класу отримується з контексту, де його визначено (базового або похідного класу), його буде показано жовтим. Якщо ж це не так, його буде показано фіолетовим.
Якщо член класу є приватним (private) або захищеним (protected), його буде розфарбовано у дещо темніший колір при використанні.
Для змінних, які є локальними для області видимості функції, використовуються кольори веселки, які програма вибирає за хешем ідентифікатора. Це стосується і параметрів функції. Ідентифікатор матиме той самий колір у її області видимості (але той самий ідентифікатор матиме інший колір, якщо відповідає іншому об'єкту, тобто його перевизначено у вкладенішій області видимості). Зазвичай, для ідентифікатора із тією самою назвою у різних областях видимості буде використано той самий колір. Отже, якщо параметри із однаковими назвами приймають декілька функцій, кольори аргументів будуть однаковими. Розфарбовування у кольори веселки можна вимкнути окремо на рівні сторінки налаштовування загального розфарбовування у діалоговому вікні параметрів програми.
Ідентифікатори, для яких KDevelop не вдалося визначити відповідне оголошення, буде розфарбовано білим кольором. Іноді причиною такого розфарбовування є пропущені директиви #include.
На додачу до цього розфарбовування буде застосовано звичайне розфарбовування синтаксичних конструкцій редактора, які відомі з Kate. Семантичне підсвічування у KDevelop завжди перевизначає підсвічування редактора, якщо виникне конфлікт.
Пересування між фрагментами коду
У попередньому розділі ми обговорювали вивчення коду програми, тобто отримання даних щодо символів, файлів та проектів. Наступним кроком є перехід між компонентами коду, тобто навігація кодом. Знову ж таки, існує декілька рівнів, на яких можна здійснювати подібну навігацію: локально, у межах файла і у межах проекту.
Зауваження
Доступ до багатьох засобів навігації можна отримати за допомогою меню Навігація головного вікна KDevelop.
Пересування поточним фрагментом
KDevelop — набагато більше, ніж просто редактор, — це також редактор коду. Тому, звичайно ж, ви можете пересувати курсор текстом за допомогою звичайних клавіш зі стрілочками. Ви також можете скористатися натисканням клавіш PageUp та PageDown і всіма іншими командами, якими можна скористатися у звичайному текстовому редакторі.
Пересування файлами та режим огляду
На рівні окремого файла у KDevelop передбачено багато способів навігації кодом програми. Приклад:
Схема: ви можете переглянути схему вмісту поточного файла в один із принаймні трьох різних способів:
Натисканням кнопки OutlineПанелі інструментів, яку, зазвичай, розташовано у лівій частині вікна.Передбачено кнопку для упорядковування усього за зростанням або спаданням та панель фільтрування. Далі, ви можете просто вибрати пункт, до якого слід перейти, або, якщо пунктів багато, почати вводити критерій пошуку, щоб у списку лишилися потрібні вам записи. Зі зростанням кількості символів у введеному критерії, список ставатиме усе меншим, оскільки з нього зникатимуть усі назви, які не містять введеного вами тексту, аж доки ви не будете готові вибрати один з варіантів, що лишився у списку.
Комбінацією клавіш Alt + Ctrl + N можна відкрити діалогове вікно зі списком усіх оголошень функцій та класів.Там також буде наведено опис того, що відбувається у поточному файлі. Крім того, у цьому діалоговому вікні ви зможете виконати пошук, якщо список є надто довгим, та вибрати оголошення для переходу до нього.
На панелі інструментів вікна навігації кодом передбачено смужку редагування тексту, до якої ви можете ввести назву функції або класу для швидкого пошуку. Можна просто клацнути на смужці редагування, щоб побачити схему. Якщо клацнути на пункті у контекстному списку, програма покаже підказку щодо пункту і посилання на його визначення та використання.
Файли коду впорядковано у список оголошень та визначень. За допомогою натискання комбінацій клавіш Alt + Ctrl + PgUp і Alt + Ctrl + PgDown можна переходити до визначення попередньої або наступної функції у файлі.
Пересування проектами та сеансами: семантичне пересування
Як ми вже згадували у інших частинах підручника, KDevelop, зазвичай, не працює із окремими файлами початкових кодів, а розглядає проєкти програмного забезпечення уцілому (або, точніше, розглядає як ціле усі проєкти, які є частиною поточного сеансу). Наслідком цього є те, що програма пропонує багато можливостей для навігації усіма проєктами. Деякі з цих можливостей є похідними від тих, які вже було обговорено у розділі щодо вивчення початкового коду, інші ж є цілком відмінними. Загальним є те, що ці можливості з навігації засновано на семантичному розумінні коду, тобто вони пропонують вам щось, що потребує обробки коду усіх проєктів і поєднання даних. У наведеному нижче списку описано деякі способи для навігації початковим кодом, який розкидано між потенційно великою кількістю файлів:
Як зазначалося у розділі щодо огляду початкового коду, програма може показувати панель підказки із поясненнями щодо простору назв, класу, функції або назв змінних у відповідь на наведення на його пункт вказівника миші або утримання протягом певного часу натиснутою клавіші Alt. Ось приклад: Клацання на посиланнях оголошення символу або розгортання списку використань надає вам змогу переходити до відповідних місць коду. Якщо потрібно, буде відкрито відповідний файл, і курсор буде переміщено до відповідного місця. Такого самого результату можна досягти використанням панелі Навігація кодом, яку ми описували раніше.
Швидко відкрити: дуже потужний спосіб переходу до інших файлів або місць, який використовується для різноманітних способів швидкого відкриття у KDevelop. Передбачено чотири версії цих способів:
Швидко відкрити клас (Навігація -> Швидко відкрити клас або Alt + Ctrl + C): ви отримаєте список усіх класів у цьому сеансі. Почніть вводити (частину) назви класу, і у список скорочуватиметься до лише тих класів, у назвах яких міститься введений фрагмент тексту. Коли список стане достатньо коротким, виберіть у ньому запис за допомогою клавіш із стрілками вгору і вниз, і KDevelop перенесе вас до місця, де оголошено клас.
Швидко відкрити функцію (Навігація -> Швидко відкрити функцію або Alt + Ctrl + M): ви отримаєте список усіх функцій (членів класів), які є частиною проєктів у поточному сеансі, і зможете вибрати потрібний запис у списку у спосіб, який описано вище. Зауважте, що до цього списку може бути включено і оголошення і визначення функцій.
Швидко відкрити файл (Навігація -> Швидко відкрити файл або Alt + Ctrl + O): ви отримаєте список усіх файлів, які є частиною проєктів поточного сеансу і зможете вибрати з нього пункт у спосіб, який описано вище.
Універсальне швидке відкриття (Навігація -> Швидко відкрити або Alt + Ctrl + Q): якщо ви не пам'ятаєте, яку з комбінацій клавіш пов'язано із описаними вище командами, можете скористатися цим універсальним засобом — він просто покаже вам комбінований список усіх файлів, функцій, класів та інших записів, з яких ви можете вибрати потрібний.
Перейти до оголошення/визначення: при реалізації функції (члена класу) часто виникає потреба у зворотному переході до місця оголошення функції, наприклад, для підтримання синхронізації списку аргументів функції між оголошенням та визначенням або оновлення документації. Для здійснення подібних переходів розташуйте курсор на назві функції і виберіть пункт меню Навігація -> Перейти до оголошення (або натисніть комбінацію клавіш Ctrl + .), щоб перейти до місця оголошення функції. Існує декілька способів повернутися до початкового місця:
Вибір пункту меню Навігація -> Перейти до визначення (або натискання комбінації клавіш Ctrl + ,).
Вибір пункту меню Навігація -> Попередній відвіданий контекст (або натисніть комбінацію клавіш Meta + ←), як це описано нижче.
Зауваження
Перехід до оголошення символу не обмежується лише функціями, які ви реалізуєте. Цей спосіб працює і у разі розташування курсора на назві (локальної, загальної чи вбудованої) змінної: вибір відповідного пункту меню призведе до пересування області перегляду до оголошення символу. Отже ви можете, наприклад, розташувати курсор на назві класу у оголошенні змінної функції і перейти до оголошення цього класу.
Перемкнути визначення/оголошення: у наведеному вище прикладі для переходу до місця оголошення поточної функції нам потрібно було спочатку розташувати курсор на назві функції. Якщо вам не хочеться цього робити, скористайтеся пунктом меню Навігація -> Перемкнути визначення/оголошення (або натисніть комбінацію клавіш Shift + Ctrl + C), щоб перейти до оголошення функції, у якій перебуває курсор. Повторний вибір цього пункту меню поверне курсор назад до визначення функції.
Попереднє/Наступне використання: якщо ви розташуєте курсор на назві локальної змінної і виберете пункт меню Навігація -> Наступне використання (або натиснете комбінацію клавіш Meta + Shift + →), програма перенесе вас до наступного використання цієї змінної у коді. (Зауважте, що при цьому не виконуватиметься простий пошук назви змінної, але враховуватиметься те, що змінні із тією самою назвою назвою, але у різних областях видимості є різними.) Те саме працює і для використань назв функцій. Вибір пункту меню Навігація -> Попереднє використання (або натискання комбінації клавіш Meta + Shift + ←) призведе до переходу до попереднього використання символу.
Зауваження
Щоб переглянути список всіх використань назв, якими здійснюватиметься циклічний перехід внаслідок використання цієї команди, розташуйте курсор на назві символу і відкрийте панель Перегляд коду або натисніть і утримуйте клавішу Alt. Докладніше про використання цього прийому можна дізнатися з розділу щодо навігації кодом.
Список контекстів: у браузерах є можливість переходити назад і вперед списком нещодавно відвіданих сторінок. У KDevelop реалізовано подібні можливості, але замість переходу між сторінками ви переходите між контекстами. Контекстом є поточне місце курсора. Ви можете змінити його переходом у будь-який спосіб, окрім команд пересування курсора, наприклад, клацанням на пункті місця на панелі підказки, на панелі інструментів Навігація кодом, на одному з пунктів у меню Навігація або використанням будь-якої іншої команди навігації. За допомогою пунктів меню Навігація -> Попередній відвіданий контекст (Meta + ←) і Навігація -> Наступний відвіданий контекст (Meta + →) ви можете переходити між пунктами у списку відвіданих контекстів так, як ви переходите між сторінками за допомогою кнопок назад і вперед у списку відвіданих сторінок у браузері. Крім того, ви можете скористатися панеллю інструментів браузера, де можна натиснути кнопку зі стрілкою ліворуч для переходу назад до попереднього файла і номера рядка, або натиснути кнопку зі стрілкою вниз, яка відкриває контекстний список попередніх відвіданих файлів та рядків.
Нарешті, передбачено панелі інструментів, за допомогою яких ви можете переходити до різних місць у програмному коді. Наприклад, на панелі Класи буде наведено список усіх просторів назв та класів в усіх проєктах поточного сеансу. У списку ви можете розгортати записи для перегляду функцій та змінних-членів кожного з цих класів: Подвійним клацанням на записі (або використанням відповідного запису контекстного меню, яке можна викликати клацанням правою кнопкою миші) ви можете перейти до місця оголошення запису. Інші засоби надають змогу виконувати подібні ж речі. Наприклад, на панелі Проєкти буде показано писок файлів, які є частиною сеансу: Знову ж таки, подвійне клацання на пункті файла призведе до його відкриття.
Введення коду
Оскільки KDevelop «розуміє» код ваших проектів, це середовище може допомогти вам у написанні коду. Нижче наведено огляд деяких з цих допоміжних можливостей.
Автозавершення
Ймовірно, найкориснішою можливістю є можливість з автоматичного завершення фрагментів коду. Розглянемо, наприклад, такий фрагмент коду:
classCar{// ...public:std::stringget_color()const;};voidfoo(){Carmy_ride;// ...do something with this variable...std::stringcolor=my_ride.ge
У останньому рядку KDevelop запам’ятає, що змінна my_ride належить до типу Car і буде автоматично пропонувати доповнення назви вбудованої функції ge у форматі get_color. Фактично, вам достатньо вводити назву, аж доки список знайдених відповідників не починатиметься з потрібного вам виразу, а потім натиснути клавішу Enter:
Зауважте, що ви можете клацнути на панелі підказки, щоб отримати більше даних щодо функції, окрім типу даних, які вона повертає, і те, чи є ця функція відкритою (public):
Автодоповнення може заощадити вам багато часу на введення тексту, якщо у вашому проєкті використовується багато довгих назв змінних та функцій. Крім того, так можна уникнути друкарських помилок у назвах (та помилок при компіляції, які є результатом таких помилок) і значно спростити запам'ятовування точних назв функцій. Наприклад, якщо усі назви функцій-отримувачів починаються із get_, можливість автодоповнення зможе показати список усіх можливих отримувачів, ввівши лише перші чотири літери, ймовірно, нагадавши вам, яку з функцій слід використати. Зауважте, що для забезпечення працездатності автодоповнення, ні оголошення класу Car, ні оголошення змінної my_ride не обов'язково мають зберігатися у тому самому файлі, у якому ви зараз пишете код. KDevelop достатньо значти, що ці класи і змінні поєднано, тобто файли, у яких виконано поєднання, мають бути частиною проєкту над якими ви зараз працюєте.
Зауваження
KDevelop не завжди може здогадатися, коли слід допомогти вам автоматичним доповненням коду. Якщо підказку автоматичного доповнення не було відкрито автоматично, натисніть комбінацію клавіш Ctrl + Пробіл, щоб відкрити список варіантів вручну. Загалом же, для того, щоб можна було скористатися автоматичним доповненням, KDevelop має обробити файли коду вашого проекту. Цю дію буде виконано у фоновому режимі для всіх файлів, які є частиною проектів поточного сеансу після запуску KDevelop, а також після того, як ви припините вводити дані на частку секунди (тривалість паузи можна змінити).
Зауваження
KDevelop виконує обробку лише тих файлів, які є файлами коду програми, відповідно до типу MIME файла. Цей тип не встановлюється до першого збереження файла. Отже створення нового файла і введення коду до цього файла не увімкне автоматичної обробки файла для використання даних з метою автоматичного доповнення. Щоб увімкнути обробку, файл доведеться зберегти.
Зауваження
Для того, щоб можна було скористатися автоматичним доповненням, KDevelop повинен мати доступ до файлів заголовків. Середовище виконає пошук цих файлів у декількох типових теках. Якщо файл заголовка не вдасться знайти автоматично, його пункт у списку буде підкреслено червоною лінією. У такому разі вам слід клацнути на цьому пункті правою кнопкою миші і повідомити KDevelop явним чином, де слід шукати цей файл та дані, які у ньому зберігаються.
Додавання нових класів та реалізація вкладених функцій
У KDevelop передбачено допоміжну програму для додавання нових класів. Її роботу описано у розділі Створення класу. Простий клас C++ можна створити за допомогою основного шаблона C++ з категорії Клас. У допоміжній програмі ви можете вибрати попередні функції-елементи, наприклад порожній конструктор, конструктор копіювання та деструктор.
Після завершення роботи допоміжної програми буде створено і відкрито у редакторі нові файли. Основу файла заголовків вже створено, а у новому класів є всі вибрані нами вбудовані функції. Наступними двома кроками мають бути документування класу та його вбудованих функцій та реалізація цих класів і функцій. Нижче ми обговоримо допоміжні засоби з документування класів і функцій. Щоб реалізувати спеціальні функції, які ми вже додали, просто перейдіть на вкладку bus.cpp, де вже є каркас наших функцій:
Щоб додати нові вкладені функції, поверніться на вкладку bus.h і додайте назву функції. Наприклад, можна додати таке:
Зауважте, що реалізацію вже розпочато. Але у межах багатьох стилів програмування функції не слід реалізовувати у файлах заголовків, це слід робити у відповідних файлах .cpp. Для цього розташуйте курсор на назві функції і скористайтеся пунктом меню Код -> Пересунути до коду або натисніть комбінацію клавіш Ctrl + Alt + S. Код між фігурними дужками буде пересунуто з файла заголовків (його буде замінено на крапку з комою для завершення оголошення функції) до відповідного файла коду:
Введення коду розпочато. Змінна students має, ймовірно, бути вбудованою змінною класу Bus, але її ще не додано до цього класу. KDevelop підкреслено цю змінну, щоб позначити те, що середовищу ще нічого не відомо про цю змінну. Цю проблему просто розв’язати: натискання назви змінної відкриє таку панель підказки:
Нарешті, метод використання пункту меню Код -> Пересунути до коду не завжди призводить до вставляння вбудованої функції до бажаного місця у коді. Наприклад, вам може бути потрібним визначення коду як inline і розташування його у нижній частині файла заголовків. У такому разі вкажіть оголошення і почніть введення визначення функції ось так:
Оголошення для документування
Хороший код завжди добре документовано, як на рівні реалізації алгоритмів у функціях, так і на рівні інтерфейсу, — тобто класи (вбудовані і загальні) функції та (вбудовані і загальні) змінні слід документувати, щоб всім було зрозумілим їхнє призначення, можливі значення аргументів, попередні та остаточні умови тощо. У документуванні інтерфейсів фактичним стандартом є формат коментарів doxygen, дані його можна видобути і показати на придатних для пошуку інтернет-сторінках.
У KDevelop передбачено підтримку коментарів у цьому форматі за допомогою скорочення для створення оболонки-коментаря, який документуватиме клас або вбудовану функцію. Наприклад, припустімо ви вже створили такий код:
classCar{public:std::stringget_color()const;};
Тепер нехай вам потрібно додати документацію для класу і вбудованої функції. Для цього пересуньте курсор на перший рядок коду і скористайтеся пунктом меню Код -> Документувати оголошення або натисніть комбінацію клавіш Alt + Shift + D. KDevelop відкриє таке діалогове вікно:
Курсор вже перебуває у затіненій області, щоб ви могли ввести короткий опис (після ключового слова doxygen @brief) цього класу. Тепер ви можете продовжити додавати документацію до цього коментаря, який краще пояснюватиме призначення класу:
Коли ви дістанетеся кінця рядка, натисніть Enter, і KDevelop автоматично розпочне новий рядок, який починатиметься із зірочки, і відступить курсором на один символ. По завершенню документування запису і натискання Enter поза областю документування, сіре підсвічування буде вилучено.
Тепер виконаємо документування вбудованої функції. Знову розташуйте курсор на рядку оголошення і виберіть пункт меню Код -> Документувати оголошення або натисніть комбінацію клавіш Alt + Shift + D:
Знову ж таки, KDevelop автоматично створить каркас коментаря разом з документації щодо самої функції, а також типом даних, які вона повертає. У нашому випадку назва функції доволі очевидно описує її призначення, але часто аргументи функції можуть бути доволі неочевидними, їх слід документувати окремо. Наприклад, розгяньмо трохи цікавішу функцію та коментар, який автоматично створить для неї KDevelop:
У нашому прикладі у запропонованому коментарі вже містяться всі поля Doxygen для окремих параметрів.
Перейменування змінних, функцій і класів
Іноді виникає потреба у перейменуванні функції, класу або змінної. Наприклад, нехай маємо такий код:
Нехай пізніше ми зрозуміємо, що назва remove_students є невдалою, і її варто назвати, скажімо, throw_out_students. Ви могли б виконати пошук з заміною назви функції, але у такого способу є два недоліки:
Функцію може бути використано у декількох файлах.
Нам потрібно перейменувати лише цю функцію і не чіпати функції, які можуть мати ту саму назву, але які оголошено у інших класах або просторах назв.
Обидві ці проблеми можна розв’язати наведенням курсора на всі використання назви функції з наступним вибором пункту Код -> Перейменувати оголошення (або клацанням правою кнопкою миші на назві з вибором пункту Перейменувати Bus::remove_students). У відповідь буде відкрито діалогове вікно, за допомогою якого ви зможете ввести нову назву функції і переглянути всі місця, де використано функцію:
Фрагменти коду
У більшості проектів зустрічаються фрагменти коду, які доводиться використовувати доволі часто. Приклади: інструкції компілятора, цикл для всіх інструкцій, для функцій запису інтерфейсу користувача перевірки введених користувачем даних без відкриття вікна повідомлення про помилку. У проекті автора цього підручника часто використовується такий різновид коду:
Замість введення тексту подібного типу знову і знову (із усіма можливими друкарськими помилками), ви можете скористатися інструментом KDevelopФрагменти. Для цього відкрийте панель інструментів (див. Інструменти і панелі перегляду, якщо відповідної кнопки ще немає на периметрі вашого вікна). Крім того, ви можете скористатися пунктом Вікно -> Панелі інструментів на верхній панелі меню і увімкнути Фрагменти. Далі, натисніть кнопку Додати сховище (дещо оманлива назва — за допомогою цього пункту можна створити іменовану збірку фрагментів для початкових кодів певного типу, наприклад, коду C++) і створіть порожнє сховище. Потім натисніть Додати фрагмент, щоб додати фрагмент і відкрити діалогове вікно, подібне до такого:
Якщо сховища із фрагментами ще не було створено, і ваш проєкт засновано на C++, використання пункту меню Інструменти -> Створити фрагмент призводить до створення сховища із назвою Фрагменти ISO C++ і записування ваших фрагментів до сховища, як це показано вище. Праворуч у діалоговому вікні Створення фрагмента розташовано панель перегляду, на якій показано фрагменти, якими можна скористатися.
Щоб скористатися таким чином визначеним фрагментом, вам слід просто почати вводити у коді його назву, як ви це робите для будь-яких інших функцій або змінних. Для введених літер буде відкрито панель автоматичного доповнення (це означає, що можна використовувати будь-які достатньо довгі для розрізнення назви фрагментів, зокрема назви, подібні до використаної нами), якщо ви виберете відповідний пункт фрагмента на панелі підказки автоматичного доповнення (наприклад, натисканням клавіші Enter), вже введену частину назви фрагмента буде замінено повним текстом фрагмента з відповідними відступами:
Зауважте, що, щоб це спрацювало, слід відкрити або зробити видимою панель інструментів Фрагменти. Альтернативним способом вставлення фрагмента є просте клацання на ньому на панелі інструментів фрагментів. Якщо навести вказівник миші на фрагмент, програма покаже вам панель перегляду коду фрагмента.
Якщо ви вже дісталися так далеко, зверніть увагу на верхній правий кут головного вікна KDevelop — ви побачити кнопку коду. Якщо натиснути цю кнопку, програма запропонує два варіанти дій: Внести поточний проєкт... (див. робота із системами керування версіями) та Діагностика (див. діагностування вад у програмах).
Для кожного з режимів передбачено власний набір інструментів, кнопки яких розташовано вздовж периметра вікна середовища, для кожного режиму передбачено власний робочий набір відкритих файлів і документів. Крім того, кожен такий робочий набір пов’язано з поточним сеансом, тобто маємо взаємозв’язок, подібний до показаного вище. Зауважте, що файли у робочому наборі є частиною одного сеансу, але можуть належати до різних проектів, які є частинами цього сеансу.
Якщо ви відкрили вікно KDevelop вперше, робочий набір буде порожнім, — ще не відкрито жодного файла. Але з відкриттям файлів для редагування (або діагностики, перегляду у інших режимах) ваш робочий набір розширюватиметься. Кожного разу, коли ви завершуватимете роботу KDevelop, а потім починатимете її знову, робочий набір буде зберігатися і відновлюватися, тобто ви працюватимете з одним набором відкритих файлів.
Якщо ви наведете вказівник миші на символ для робочого набору, програма покаже панель підказки зі списком файлів, які відкрито у цьому робочому наборі (у нашому прикладі це файли helper.h, helper.cpp, filemanagerlistjob.h та filemanagerlistjob.cpp). Піктограма робочого набору може мати різні кольори у різний час, але ці кольори не мають певного значення. Клацання на квадраті зі знаком «мінус» закриє вкладку для відповідного файла у робочому наборі. Суть роботи пункту закриття робочого набору полягає у тому, що його вибір не лише закриває усі файли, але і просить вас зберегти усі файли, до яких внесено зміни, але які не збережено, і відкриває новий порожній набір.
Деякі корисні клавіатурні скорочення
У редакторі KDevelop використано стандартні клавіатурні скорочення для звичайних дій з редагування. Ці скорочення можна змінити, якщо у вас виникне така потреба.
Передбачено пункт для налаштовування і зберігання різних схем клавіатурних скорочень. За допомогою відповідного вікна ви можете експортувати та імпортувати будь-які ваші схеми.
Втім, передбачено також підтримку декількох додаткових дій при редагуванні початкового коду. Деякі з цих дій пов'язано із натисканням певних комбінацій клавіш. Зокрема, часто є зручними такі комбінації:
Пересування кодом
Ctrl+Alt+O
Пришвидшене відкриття файла: вкажіть частину назви файла і виберіть той з них у каталозі проектів поточного сеансу, який вам потрібен; цей файл і буде відкрито.
Ctrl+Alt+C
Пришвидшене відкриття класу: вкажіть частину назви класу і виберіть ту з назв класів, яка вам потрібна; курсор буде переведено до рядка оголошення класу.
Ctrl+Alt+M
Пришвидшене відкриття функції: вкажіть частину назви функції (частини класу) і виберіть з запропонованих варіантів той, який вам потрібен; зауважте, що у списку буде показано оголошення і визначення, а курсор буде переведено до вибраного вами пункту.
Ctrl+Alt+Q
Універсальне пришвидшення відкриття: вкажіть будь-які дані (назву файла, назву класу, назву функції), і вам буде показано список всіх частин проекту, які відповідають критерію пошуку.
Ctrl+Alt+N
Огляд: показує список всіх дій, які виконуються у файлі, наприклад, оголошень класів та визначень функцій.
Ctrl+,
Перейти до визначення функції, якщо курсор перебуває у місці її оголошення.
Ctrl+.
Перейти до оголошення функції або змінної, якщо курсор перебуває у позиції визначення функції.
Ctrl+Alt+PageDown
Перейти до наступної функції
Ctrl+Alt+PageUp
Перейти до попередньої функції
Ctrl+G
Перейти до рядка
Пошук і заміна
Ctrl+F
Знайти
F3
Знайти далі
Ctrl+R
Замінити
Ctrl+Alt+F
Знайти і замінити у декількох файлах
Інші команди
Ctrl+_
Згорнути один рівень: вилучити блок з перегляду, наприклад, якщо ви бажаєте зосередитися на загальнішій картині у функції.
Ctrl++
Розгорнути один рівень: скасувати згортання.
Ctrl+D
Зняти коментування з позначеного фрагмента тексту або поточного рядка.
Ctrl+Shift+D
Додати позначки коментаря до позначеного тексту або поточного рядка.
Alt+Shift+D
Документувати поточну функцію. Якщо курсор перебуває на оголошенні функції або класу, натискання цієї комбінації клавіш призведе до створення коментаря у форматі doxygen зі списком параметрів, значень, які повертаються, тощо.
Ctrl+T
Поміняти місцями поточний і попередній символи
Ctrl+K
Вилучити поточний рядок (зауваження: ця дія не збігається за результатом з дією «вилучити звідси до кінця рядка» у emacs)
