Целью данной работы является разработка программной средств, позволяющих проверить корректность примеров, содержащихся в документации программ, написанных на языке Kotlin. Задачи, которые решались в ходе выполнения работы: 1. Обзор и анализ существующих способов интеграции примеров в документацию к программному коду и их недостатков. 2. Определение нового формата написания примеров в документации. 3. Разработка программного модуля для системы автоматизации сборки, позволяющего извлекать такие примеры из документации и осуществлять их проверку. 4. Разработка программного модуля для интегрированной среды разработки, облегчающего написание примеров и их проверку. 5. Тестирование разработанных программных средств и оценка результатов. В результате выполнения работы была получена программная система из двух подключаемых программных модулей, интегрированных в средства разработки. Вместе они выполняют поставленную задачу проверки примеров.

The purpose of this work is to develop software tools that allow you to check the correctness of the examples contained in the documentation of programs written in the Kotlin language. Tasks that were solved in the course of the work: 1. Review and analysis of existing methods for integrating examples into code documentation and their shortcomings. 2. Definition of a new format for writing examples in the documentation. 3. Development of a software module for a build automation system that allows you to extract such examples from the documentation and test them. 4. Development of a program module for an integrated development environment that facilitates writing and testing examples. 5. Testing of developed software tools and evaluation of results. As a result of the work, a software system was obtained from two plug-in software modules integrated into the development tools. Together, they accomplish the task of testing the examples.

• ПЕРЕЧЕНЬ УСЛОВНЫХ ОБОЗНАЧЕНИЙ И ТЕРМИНОВ
• ВВЕДЕНИЕ
• 1. АНАЛИЗ СУЩЕСТВУЮЩИХ СПОСОБОВ ИНТЕГРАЦИИ ПРИМЕРОВ В ДОКУМЕНТАЦИЮ
• 2. ПОСТАНОВКА И АНАЛИЗ ЗАДАЧИ
• 3. РАЗРАБОТКА ПРОГРАММНОГО РЕШЕНИЯ
  • 3.1. Извлечение примеров из документации
  • 3.2. Генерация кода
  • 3.3. Разработка программного модуля для Gradle
  • 3.4. Разработка программного модуля для Intellij IDEA
• 4. ТЕСТИРОВАНИЕ СИСТЕМЫ
  • 4.1. Автоматическое тестирование модуля для Gradle
  • 4.2. Автоматическое тестирование модуля для Intellij IDEA
  • 4.3. Ручное тестирование
• 5. ПУБЛИКАЦИЯ ПРОЕКТА
• ЗАКЛЮЧЕНИЕ
• СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ
• Приложение 1. Основные части программного модуля для Gradle
• Приложение 2. Основные части программного модуля для Intellij IDEA
• Приложение 3. Тесты к программному модулю для Gradle
• Приложение 4. Тесты к программному модулю для Intellij IDEA