С.В. Акимов

МЕТОД ЗАМЕЩЕНИЯ КОММЕНТАРИЕВ ДЛЯ СОЗДАНИЯ КОДА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

(оригинал: Акимов С.В. Метод замещения комментариев для создания кода программного обеспечения // Современные проблемы информатизации в информационных системах и телекоммуникациях: сборник трудов. Выпуск 11 / Воронеж, С. 216-218.)

В работе предложен метод создания программного кода. Суть данного метода состоит в том, что сначала пишутся комментарии к программе, а затем уже пишется код, «замещающий» эти комментарии. Отсюда и название метода.

Несмотря на свою простоту, данный метод хорошо зарекомендовал себя при разработке автором различного программного обеспечения, а также в учебном процессе при выполнении студентами курсовых работ по курсу «Технология программирования» и в процессе работы над дипломными проектами и магистерским диссертациями.

Рассмотрим данный метод на примере. Предположим, что в программе необходимо реализовать алгоритм, определяющий максимальное значение элементов, хранящихся в массиве anArray, и выводящий это значение на экран. Последовательность действий будет следующей.

Сначала запишем требуемое условие:

//Найти максимальное значение и вывести его на экран

Теперь создадим алгоритм на естественном языке:

//Найти максимальное значение и вывести его на экран

//Вводим переменную “размер массива”

//Переменной "Максимальное значение" присваиваем
//значение первого элемента массива

//Осуществляем проход по массиву, начиная со второго элемента

       //Если значение элемента массива больше значения переменной
       //"Максимальное значение",
       //то присваиваем ей значение этого элемента
       
//Выводим максимальное значение

Далее, пишем код, реализующий наш алгоритм («замещаем» комментарии):

//Найти максимальное значение и вывести его на экран

//Вводим переменную “размер массива”
int nSize = anArray.GetSize();

//Переменной "Максимальное значение" присваиваем
//значение первого элемента массива
int nMax = anArray.GetAt(0);
//Осуществляем проход по массиву, начиная со второго элемента
for(int i = 1; i < nSize; i++)
{
       //Если значение элемента массива больше значения переменной
       //"Максимальное значение",
       //то присваиваем ей значение этого элемента
       if(anArray.GetAt(i) > nMax)
       		nMax = anArray.GetAt(i);
}
//Выводим максимальное значение
cout << "Max number is: " << nMax << "\n";

Как видно из приведенного примера, при использовании метода замещения комментариев программа создается в процессе ее последовательной проработки и уточнения. Так, сначала записывается, что должна делать программа. Далее уточняется, как этого достичь (также, возможно, в несколько этапов). И наконец, пишется программный код, «замещающий» созданные комментарии.

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

Кроме того, при использовании предложенного метода необходимо соблюдать правила форматирования, используя табуляцию для каждого следующего уровня вложенности.

Хотя для целей представления алгоритмов существует богатый арсенал средств визуального моделирования (блок-схемы, диаграммы Насси-Шнейдермана, FLOW-диаграммы), они часто не используются программистами из-за своей громоздкости. Предложенный метод не призван заменить визуальные средства моделирования, а лишь дополняет их. Так, диаграммы и блок-схемы целесообразно использовать на достаточно высоком уровне абстракции, а метод замещения комментариев – при более детальной проработке.

Достоинствами предложенного метода являются:

• практическая направленность;
• компактность;
• не требуются графические редакторы или CASE-системы;
• текст программы содержит подробные «замещенные» комментарии.