Файл «Описание применения» внутри архива находится в папке «Готовое ДЗ неизвестного варианта (8)». Документ из архива «Готовое ДЗ неизвестного варианта (8)», который расположен в категории » «. Всё это находится в предмете «объектно-ориентированное программирование (ооп)» из 3 семестр, которые можно найти в файловом архиве МГТУ им. Н.Э.Баумана.
Не смотря на прямую связь этого архива с МГТУ им. Н.Э.Баумана, его также можно найти и в других разделах. Архив можно найти в разделе «курсовые/домашние работы», в предмете «объектно-ориентированное программирование (ооп)» в общих файлах.
Онлайн просмотр документа «Описание применения»
Текст из документа «Описание применения»
Московский государственный технический университет им. Н.Э.Баумана _________________________________________________________________
| Утверждаю: | |
| Большаков С.А. | «__»_____________2009 г. |
Домашнее задание по дисциплине ООП “ Классы слов и предложений» Описание применения программного продукта (вид документа) писчая бумага (вид носителя) 4 (количество листов)
Как работает программа? Как компилируется код? (устройство компьютерных программ) [2020]
| ИСПОЛНИТЕЛЬ: | |
| студент группы ИУ5-34 | _____________________ |
| Белоус К.С. | «__»_____________2009 г. |
Москва 2009 ________________________________________________________________
Общие характеристики программного обеспечения.
Назначение программного обеспечения.
ОПИСАНИЕ КОДА ПРОГРАММЫ
Полный код программы можно посмотреть в Приложении А. Рассмотрим наиболее важные части кода.
Интерфейс программы прост и интуитивно понятен
Из выше приведенной части кода программы понятно, что интерфейс программы состоит в основном из двух окон и четырех кнопок.
Для хранения правил используется массив из строк. В программе этот массив носит глобальное имя P. Массив Р может вместить максимум 40 строк.
p: array [0..40] of string;
При работе алгоритма проверки грамматики правила считываются с формы из специального компонента Memo1, а результат выгружается в Memo2. Для работы алгоритмов устранения бесплодных и недостижимых символов данные подгружаются из компонента Memo2 и туда же выгружается результат. Количество правил соответствует количеству строк в этом компоненте, то есть рассчитано, что каждое правило будет вводиться на отдельной строке.
В программе предусмотрено множество mn для хранения нетерминальных (вспомогательных) символов.
if p[i,j] in [‘A’..’Z’] then mn[i]:=mn[i]+[P[i,j]];
Для выделения множества нетерминалов просматривается каждое правило и заглавные буквы латинского алфавита, встречающиеся в правилах, автоматически относятся к нетерминалам. Т.к. тип «множество» содержит неповторяющиеся элементы, то в mn соберутся элементы только по одному разу.
Архитектура ПО. Введение
Правила видимо записываются так «символ»>«слово». Таким образом, правая часть правила начинается с 3 символа, поэтому и всю работу с правилом начинаем с третьего символа.
Источник: studwood.net
Документирование javadoc
При документировании приложения необходима также поддержка документации программы. Если документация и код разделены, то непроизвольно создаются сложности, связанные с необходимостью внесения изменений в соответствующие разделы сопроводительной документации при изменении программного кода.
Как правило, все существующие среды разработки IDE приложений Java предлагают решение по связыванию кода с документацией в процессе разработки с использованием javadoc. Для этого необходимо соответствующим образом написать комментарий к коду, т.е. документировать. Java комментарии необходимы как для комментирования программы, так и для составления или оформления документации.
Разработан специальный синтаксис для оформления документации в виде комментариев и инструмент для создания из комментариев документации. Этим инструментом является javadoc, который обрабатывая файл с исходным текстом программы, выделяет помеченную документацию из комментариев и связывает с именами соответствующих классов, методов и полей. Таким образом, при минимальных усилиях создания комментариев к коду, можно получить хорошую документацию к программе.
javadoc — это генератор документации в HTML-формате из комментариев исходного кода Java и определяет стандарт для документирования классов Java. Для создания доклетов и тэглетов, которые позволяют программисту анализировать структуру Java-приложения, javadoc также предоставляет API. В каждом случае комментарий должен находиться перед документируемым элементом.
При написании комментариев к кодам Java используют три типа комментариев :
// однострочный комментарий; /* многострочный комментарий */ /** комментирование документации */
С помощью утилиты javadoc, входящей в состав JDK, комментарий документации можно извлекать и помещать в НТМL файл. Утилита javadoc позволяет вставлять HTML тэги и использовать специальные ярлыки (дескрипторы) документирования. НТМL тэги заголовков не используют, чтобы не нарушать стиль файла, сформированного утилитой.
Комментарии документации применяют для документирования классов, интерфейсов, полей (переменных), конструкторов и методов. В каждом случае комментарий должен находиться перед документируемым элементом.
Форма документирования кода
Документирование класса, метода или переменной начинается с комбинации символов /** , после которого следует тело комментариев; заканчивается комбинацией символов */.
Среда разработки IDE, как правило, помогает программисту «подсветкой» встроенной документации. На следующих рисунках приведены скриншоты всплывающих окон IDE Eclipse.
Утилита javadoc в качестве входных данных принимает файл с исходным кодом программы, для которого генерируется НТМL файл. Документация для каждого класса содержится в отдельном НТМL файле. Кроме этого, создается дерево индексов и иерархии. Могут быть сгенерированы и другие НТМL файлы.
Сценарии ant и javadoc
Для создания документации можно использовать ant.
Пример сценария (задания) ant для формирования документации к приложению MyProject :
Подробная информация формирования документации представлена на странице Javadoc/Javadoc2
Источник: java-online.ru