Рабочая среда К

3.4. Дополнительные составляющие проекта KDevelop

Кроме исходного кода, проект KDevelop содержит множество других частей, интересных для разработчика. Это:

Кроме API -документации, эти элементы проекта будут инсталлированы вместе с бинарными файлами приложения. Чтобы проект был как можно более открытым, вы должны согласовать эти его части с функциями приложения. Во-первых, вы должны отредактировать иконки. Это даст вашему приложению уникальный идентификатор, с помощью которого пользователь сможет узнать ваше приложение в окне менеджера меню. Файл .kdelnk - это файл, который добавляет ваше приложение в kpanel в меню Applications. Он должен быть отредактирован - необходимо установить путь для инсталляции, что будет обсуждаться далее в этой книге. Наконец, документация, которую вы предоставите пользователю, пишется в SGML . Это делает очень простым создание нескольких конечных файлов различных форматов из одного исходника. По умолчанию, KDevelop предлагает создать HTML файлы из этого исходника, для KDE-проектов это делается автоматически с использованием ksgml2html , что добавляет классический KDE-вид документации. В последующих главах мы увидим, как редактировать файл SGML , и что мы предоставим конечному пользователю для инсталляции.

Наконец, API -документация (Application Programming Interface) позволит вам и другим разработчикам быстро понять код и использовать классы, не угадывая, для чего они предназначены. Мы научимся создавать API -документацию позднее. На текущий момент достаточно знать, что документация генерируется программой KDoc , которая обрабатывает файлы заголовков и создает HTML документ, поэтому все подлежащие включению в документацию комментарии должны располагаться в заголовках.