Файл: Разработать справочную систему по стандартным функциям выбранного языка программирования ( С++).pdf

ВУЗ: Не указан

Категория: Курсовая работа

Дисциплина: Не указана

Добавлен: 01.04.2023

Просмотров: 177

Скачиваний: 3

ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.

CHM Builder - программа предназначена для создания CHM-файлов (компилированных HTML-документов). Содержит в себе все файлы предназначенные для создания CHM-файлов поэтому для работы не требуется устанавливать специальные библиотеки и модули.

Рисунок 14 – Рабочее окно приложения CHM Builder

HtmlInRes - утилита не требует установки, предназначена для создания ресурсных файлов (*.RES) из набора HTML и других типов файлов. При обработке HTML-файлов заменяются все ссылки для внутренних переходов.

Рисунок 15.-. Рабочее окно приложения HtmlInRes

Syntext Serna Free - XML редактор который может создать документы таких форматов как техническая документация, руководства пользователя, статьи, книги, листинги программ и т.п.

Рисунок 16 – Рабочее окно приложения Syntext Serna Free

DRExplain - программа может создать документы таких форматов как: HTML, CHM, RTF, RDF.

В программе есть встроенная технология анализа структуры пользовательского интерфейса.

Благодаря чему может анализировать пользовательский интерфейс приложений и создавать скриншоты окон, автоматически расставляя на них пояснительные выноски для элементов интерфейса.

Функциональные возможности:

-Возможность экспорта проекта в основные форматы справочной документации;

-В Dr.Explain присутствует уникальная возможность – захват выбранной вами области экрана либо экрана целиком для последующего использования в документации. Подобная операция легко осуществляется нажатием нескольких кнопок, и результат сразу оказывается в тексте проекта;

-При создании CHM справки может возникнуть необходимость в индексированном поиске, а для этого придётся использовать ключевые слова, которые можно легко задать;

-Также можно указать статус для раздела документации. Всего существует четыре статуса:

-Не начато – активен по умолчанию, ничем не выделяется;

-В работе – выделяется жёлтым цветом, можно использовать для того, чтобы отметить редактируемый раздел;

-Закончено – выделяется зелёным цветом, для выделения уже законченных разделов документации;

-Ожидается – выделяется красным цветом, для выделения тех разделов, которые планируется редактировать.

-Очень легко можно поменять название темы и получаемого при экспорте файла, настройки экспорта и статус. Для этого достаточно в левой нижней части главного окна Dr.Explain выбрать соответствующую строку и изменить заданные параметры;


-При желании можно скрыть тему, чтобы при экспорте документации она не появилась. Dr.Explain предоставляет и такую возможность; Также возможно осуществить импорт документации из внешних файлов для последующего редактирования; Возможность использования сочетания клавиш для более быстрой и удобной работы.

-Также во вкладке Инструменты можно проверить проект на ошибки, в результате чего можно выявить:

-Наличие имен файлов в темах;

-Невалидные (недействующие) ссылки;

-Непривязанные термины. Может возникнуть в том случае, если ключевое слово не привязано к какой-либо теме.

-Использование функции Сжатие проекта позволяет осуществить удаление неактивных элементов, в результате чего уменьшается объём проекта и увеличивается скорость выполнения работы;

-Также можно задать переменные, например, версию документа, чтобы в дальнейшем можно было использовать её в работе. Например, в процессе работы была создана переменная Version, которая отражает версию документа, и ей было присвоено значение 1.1. Если через какое-то время после публикации проекта потребовалось внести изменение в документацию, то нужно также внести изменение в переменную, после чего она меняется автоматически во всех разделах, в которых размещена.

-Если в наличии есть проект в формате GUI, то используя командную строку, можно создать документацию в ключевых форматах, не показывая окно программы;

-Также Dr.Explain можно использовать для быстрого создания документации, а также для автоматизации этого процесса за счёт использования импорта настроек проекта. Работа над проектом завершена, но хочется использовать его настройки в будущем? Элементарно, Dr.Explain позволяет осуществить это. Для этого потребуется сделать всего три клика мышкой, и новый проект будет иметь точно такие же настройки, как и предыдущий;

-Более того, можно одновременно работать с несколькими проектами. Для этого нужно лишь расположить окна проектов рядом или каскадом, что очень легко осуществить, используя вкладку Окно;

-Если организована совместная работа над проектом и один из исполнителей не хочет, чтобы его часть была изменена, существует возможность блокирования нужных разделов. Достаточно кликнуть правой кнопкой мыши по разделу и выбрать соответствующий вариант блокировки. Необходимо иметь ввиду, что данную блокировку легко снять, поскольку для этого всего лишь требуется нажать правой кнопкой мыши по разделу и выбрать пункт Разблокировать, если заблокирована одна страница, либо же Разблокировать текущий и потомков, если заблокирован раздел с подразделами;


-Возможность экспорта карты сайта и индекса карты сайта. Для этого достаточно нажать на вкладку Инструменты и выбрать один из пунктов, после чего появится диалоговое окно, в котором будет предложено выбрать место сохранения карты сайта или индекса карты сайта;

-Если на рабочем месте нет Adobe Reader или MS HTML Help Workshop, то, к сожалению, будет отсутствовать возможность экспорта в PDF и CHM формат соответственно. Тем не менее, не нужно разочаровываться, поскольку Dr.Explain предлагает ссылки на скачивание данных продуктов, являющихся бесплатными, с официальных сайтов.

Рисунок 17 – Рабочее окно приложения DRExplain

Для создания справочной системы однозначно выбрана программа DRExplain. В отличии от других программ представленных в данной работе, DRExplain отличается большим функционалом, имеет статус бесплатной программы, может работать со многими форматами, присутствует возможность работать с несколькими проектами сразу, есть возможность делать захват экрана для последующего использования в работе, присутствует возможность блокировать разделы, в программе есть встроенная технология анализа структуры пользовательского интерфейса, присутствует встроенная технология анализа структуры проекта, допускается создание одного проекта и представление его в разных форматах справочной системы.

    1. Обоснование выбора языка программирования

В мире существует огромное количество языков программирования. Они предоставляют программисту набор инструментов, с помощью которых и создаются программы. Самые популярные языки, на данный момент, это :C/C++, C#, Java, Python, Swift, Kotlin.

Рассмотрим их более детально.

- Язык Java является объектно-ориентированным и поставляется с достаточно объемной библиотекой классов. Библиотеки классов Java значительно упрощают разработку приложений, предоставляя в распоряжение программиста мощные средства решения распространенных задач. Поэтому программист может больше внимания уделить решению прикладных задач, а не таких, как, например, организация динамических массивов, взаимодействие с операционной системой или реализация элементов пользовательского интерфейса.

Язык Java зародился как часть проекта создания передового программного обеспечения для различных бытовых приборов. Реализация проекта была начата на языке С++, но вскоре возник ряд проблем, наилучшим средством борьбы с которыми было изменение самого инструмента - языка программирования. Стало очевидным, что необходим платформенно-независимый язык программирования, позволяющий создавать программы, которые не приходилось бы компилировать отдельно для каждой архитектуры и можно было бы использовать на различных процессорах под различными операционными системами.


Язык должен был воплощать следующие качества: простоту и мощь, безопасность, объектную ориентированность, надежность, интерактивность, архитектурную независимость, возможность интерпретации, высокую производительность и легкость в изучении. Даже если вы никогда не напишете ни одной строки на языке Java, знать о его возможностях весьма полезно, поскольку именно перечисленные выше свойства языка придают динамику страницам Всемирной паутины.

Поскольку язык Java предназначен для использования в сетевой или распределенной среде, то вопросам его безопасности было уделено большое внимание. На данный момент язык Java позволяет создавать системы, надежно защищенные от вирусов и несанкционированного доступа.Язык Java разрабатывался как чисто объектно-ориентированный язык, в отличие от С++, объектная парадигма которого «ослабляется» возможностями, оставшимися от языка С. В Java отсутствуют такие структуры С++, как struct, union и procedure; они заменены на методы, интерфейсы и более развитые классы.Функции и процедуры в Java заменены на конструкции, называемые методами. Методы очень напоминают процедуры языка С++ за исключением того, что методы не могут быть независимыми от класса (кроме методов из интерфейсов).В Java, как и в С++, возможны множественные конструкторы, дающие программисту возможность инициализировать объект различными способами. При объявлении конструкторов существуют два основных правила: имя конструктора и название класса должны совпадать; при объявлении конструктора не указывается возвращаемый тип. Как и другие ссылочные переменные, классы создаются динамически при помощи ключевого слова new.

- Python — высокоуровневый язык программирования общего назначения, ориентированный на повышение производительности разработчика и читаемости кода. Синтаксис ядра Python минималистичен. В то же время стандартная библиотека включает большой объём полезных функций.

Python поддерживает структурное, объектно-ориентированное, функциональное, императивное и аспектно-ориентированное программирование. Основные архитектурные черты — динамическая типизация, автoматическое управление памятью, полная интроспекция, механизм обработки исключений, поддержка многопоточных вычислений, высокоуровневые структуры данных. Поддерживается разбиение программ на модули, которые, в свою очередь, могут объединяться в пакеты.

Python — активно развивающийся язык программирования, новые версии с добавлением/изменением языковых свойств выходят примерно раз в два с половиной года. Язык не подвергался официальной стандартизации, роль стандарта де-факто выполняет CPython, разрабатываемый под контролем автора языка.


- Язык программрования Swift — открытый мультипарадигмальный компилируемый язык программирования общего назначения. Создан компанией Apple в первую очередь для разработчиков iOS и macOS. Swift работает с фреймворками Cocoa и Cocoa Touch и совместим с основной кодовой базой Apple, написанной на Objective-C. Swift задумывался как более лёгкий для чтения и устойчивый к ошибкам программиста язык, нежели предшествовавший ему Objective-C. Программы на Swift компилируются при помощи LLVM, входящей в интегрированную среду разработки Xcode 6 и выше. Swift может использовать рантайм Objective-C, что делает возможным использование обоих языков (а также С) в рамках одной программы.

Swift заимствовал довольно многое из Objective-C, однако он определяется не указателями, а типами переменных, которые обрабатывает компилятор. По аналогичному принципу работают многие скриптовые языки. В то же время, он предоставляет разработчикам многие функции, которые прежде были доступны в C++ и Java, такие как определяемые наименования, обобщения и перегрузка операторов.

Часть функций языка выполняется быстрее по сравнению с другими языками программирования. Например, сортировка комплексных объектов выполняется в 3,9 раз быстрее, чем в Python, и почти в 1,5 раза быстрее, чем в Objective-C.

Код, написанный на Swift, может работать вместе с кодом, написанным на языках программирования C и Objective-C в рамках одного и того же проекта.

- Язык программирования Kotlin представляет статически типизированный язык программирования от компании JetBrains. Kotlin можно использовать для создания мобильных и веб-приложений.

Kotlin работает поверх виртуальной машины Java (JVM) и при компиляции компилируется в байткод. То есть, как и в случае с Java, мы можем запускать приложение на Kotlin везде, где установлена JVM. Хотя также можно компилировать код в JavaScript и запускать в браузере. И, кроме того, можно компилировать код Kotlin в нативные бинарные файлы, которые будут работать без всякой виртуальной машины. Таким образом, круг платформ, для которых можно создавать приложения на Kotlin, чрезвычайно широк - Windows, Linux, Mac OS, iOS, Android.

Первая версия языка вышла 15 февраля 2016 года. Хотя сама разработка языка велась с 2010 года. Текущей версией языка на данный момент является версия 1.2, которая вышла 28 ноября 2017 года.

Kotlin испытал влияние многих языков: Java, Scala, Groovy, C#, JavaScript, Swift и позволяет писать программы как в объектно-ориентированном, так и в функциональном стиле. Он имеет ясный и понятный синтаксис и довольно легок для обучения.

Самым популярным направлением, где применяется Kotlin, является прежде всего разработка под ОС Android. Причем настолько популярным, что компания Google на конференции Google I/O 2017 провозгласила Kotlin одним из официальных языков для разработки под Android (наряду с Java и C++), а инструменты по работе с данным языком были по умолчанию включены в функционал среды разработки Android Strudio начиная с версии 3.0.