Методы проектирования программ
Документирование программы
Практическая работа № 19 «Отладка программы»
К выпуску программы компания-разработчик должна подготовить документацию на программу. Руководство пользователя (это наиболее важная часть документации) содержит всю информацию, необходимую для использования программы:
• назначение программы;
• формат входных данных;
• формат выходных данных;
• примеры использования программы.
Для примера составим документацию на простую программу, отладкой которой мы только что занимались.
Назначение программы: вычисление корней квадратного уравнения ах2 + bх + с = 0.
Формат входных данных: значения коэффициентов а, b и с вводятся с клавиатуры через пробел в одной строке.
Формат выходных данных: значения корней уравнения выводятся на экран через пробел в одной строке; перед значением первого корня выводится текст х1=, перед значением второго корня — текст х2=.
Пример использования программы (решение уравнения х2 - 5х + 6 = 0):
Введите а, b, с: 1 -5 6
х1=4.791288 х2=0.208712
Следующая страница Выводы