Як розробити просту програму C.
Як розробити просту програму C.
Остання редакція: січень 1999 р
(Мак-Кенн)
Здається, студенти завжди мають проблеми з розумінням (або, можливо, просто виконанням) того, що я від них очікую, коли я призначаю програму. Вимоги дійсно дуже прямі; в основному це питання залишити собі достатньо часу, щоб все зробити.
Щоб допомогти вам зрозуміти, що від вас очікується, у цьому документі я візьму простий зразок завдання програмування та проведу вас через основні етапи процесу розробки програми.
(Якщо ви шукаєте детальну інформацію про програмну документацію, ви знайдете дещо тут, але вам дійсно слід відвідати мою сторінку стилю програмування, де є моя колекція стильових документів, включаючи кілька сторінок стилів від інших людей. Більшість із них розроблено досвідченими Програмістів. Цей документ призначений для студентів, які тільки починають вивчати C.)
Крок No1: Почніть рано
Програмування - це не та діяльність, яку можна надійно запланувати на заздалегідь визначену кількість часу. Навіть програми, схожі на те, що вони мають бути виконані за 2 години, часто вимагають 4–5 годин. Найкраще, що ви можете зробити для себе, це сказати: "Я не уявляю, скільки часу це займе; мені краще почати негайно".
Крок 2: Уважно прочитайте роздатковий матеріал
Мої роздаткові завдання з програмування, як правило, дуже детальні, якщо не ідеально організовані. Все, чого я чекаю від вас, там десь подано, тож уважно прочитайте і виділіть ключові моменти, щоб не пропустити жодного з них.
Наприклад, розглянемо цей приклад призначення:
COMSC 1613 Програмування I
Програма № 0: Калорії через жир
Дата закінчення: Смерть 36-го, 2028, на початку заняття
Ви повинні виконати це призначення в системі AIX1.
Огляд: Будь-який дієтолог скаже вам, що обмеження щоденного споживання жиру до 30% від загальної кількості калорій - це гарна ідея. Але скільки калорій у вашій улюбленій їжі складається з жиру? Харчові ярлики повідомлять вам, скільки грамів жиру в порції, і скільки загальної кількості калорій у цій порції, але решту питань потрібно робити самостійно.
Як це трапляється, грам жиру має близько 9 калорій. Тому, якщо взяти грами жиру в порції певної їжі, помножити його на 9 і розділити на загальну кількість калорій у порції, ви отримаєте частку калорій за рахунок жиру. Щоб отримати результат у відсотках, просто помножте на 100.
Наприклад, розглянемо продукт, який містить 3 грами жиру і 170 калорій на порцію. Є 27 калорій завдяки жиру (3 * 9), і 27/170 = 0,1588. Помноження на 100 дає остаточну відповідь: 15,88 відсотка калорій припадає на жир.
Завдання: Напишіть повну, добре задокументовану програму С, яка починається з прохання користувача ввести грами жиру та калорії в порцію харчового продукту. Програма обчислить відсоток калорій у їжі, що спричинені жиром, і відобразить вхідну інформацію та відсоток у вигляді повного англійського речення.
Дані: Запустіть програму двічі, один раз для кожного набору даних, показаних у наступній таблиці:
Загальна калорійність
Здайте: У встановлений термін здайте такі пункти: роздруківку вашої задокументованої програми C та роздруківку результатів, які ваша програма видала під час запуску на кожному з наборів даних, наведених вище. Обов’язково напишіть своє ім’я у верхньому правому куті роздруківки; це полегшить вам повернення вашої програми, коли я поверну її вам.
Крок 3: Напишіть зовнішню документацію
Я вже чую посмішку ("Напишіть коментарі зараз! Станьте серйозним!"), Але я серйозно: вам слід писати свою документацію під час написання програми, а не пізніше. Зокрема, зовнішня документація повинна бути майже повною, перш ніж ви напишете навіть рядок коду.
Я роздаю однокласний документ своїм класам програмування, де перелічується інформація, яку я очікую побачити у ваших програмах. Зокрема, ось що має містити Зовнішня документація:
- Ваше ім'я, назва курсу, ім'я/номер завдання, ім'я викладача та термін виконання.
- Опис проблеми, для вирішення якої була написана програма.
- Підхід, використаний для вирішення проблеми. Це завжди повинно містити короткий опис основних використовуваних алгоритмів або їх назви, якщо це загальні алгоритми.
- Робочі вимоги програми: Яку мовну систему ви використовували, спеціальну інформацію про компіляцію, де вхідні дані можуть бути розташовані на диску тощо.
- Потрібні функції завдання, які ви не змогли включити.
- Тут також слід повідомляти про відомі помилки. Якщо певна функція працює некоректно, у ваших інтересах бути чесним і повним щодо недоліків вашої програми.
mc/docs/external.c також. Наявність копії на AIX1 приємна, оскільки ви можете скористатися командою імпорту файлів вашого редактора (наприклад, r у редакторі vi), щоб залишити її у своїй програмі; імпорт шаблону може значно заощадити набір тексту.
Ось як виглядає шаблон:
Зауважте, що до кожного розділу я включив кілька коротких коментарів, щоб повідомити, що потрібно додати. Оскільки видалення всіх цих коментарів - це проблема, у мене є версія для коментарів на AIX1 під назвою ext.c, яку ви можете замість цього імпортувати. Він знаходиться в тому ж каталозі, що і external.c .