Стиль оформления текстов модулей

Стиль оформления текстов модулей определяет использование отступов, пропусков строк и комментариев, облегчающих понимание программы. Большинство современных средств автоматизированной разработки программного обеспечения (IDE – интегрированные среды разработки) сами выполняют «грязную работу» по горизонтальному выравниванию блоков кода, однако такие программные системы изначально ориентирована на высокопроизводительные рабочие станции, оснащенные дисплеем с высокой разрешающей способностью.

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

В сообществе Си-программистов были выработаны две нотации формирования горизонтальных пробельных отступов, это нотации «2 и 2» и «4 и 4». Нотация «2 и 2» регламентирует использование 2 пробельных позиций каждый раз при входе в «блок операций». Нотация «4 и 4» -соответственно 4 символьных позиций. Между блоками кода рекомендуется вставлять пустые строки и строки комментарии, поясняющие назначение этих блоков.

Пример 1

/* Блок поиска наименьшего значения в массиве целочисленных значений */

/* Размер массива: 10 элементов, minCount – искомое минимальное значение */

for(i=1, minCount = Arr[0]; i<10; i++)

{ /* Сравнение значения «текущего» элемента массива c */

if(minCount>Arr[i]) /* найденным на предыдущем шаге цикла минимальным */

{ /* значением. Если условие «истинно», то формируется */

minCount=Arr[i]; /* новое минимальное значение. */

}

}

Пример 2

/* Проверка на принадлежность контролируемого значения заданному интервалу */

if(curCount<minCount || curCount>maxCount)

{

printf(“Not the correct value.”);

/* блок обработки не корректного значения */

...

}

При составлении комментариев к исходному тексту программы (листингу) следует придерживаться следующих правил:

· комментарии должны помогать понять ход обработки данных в программе;

· комментарии должны описывать ограничения, налагаемые на используемые в программе данные;

· комментарии могут использоваться как средство визуального разделения блоков кода;

· не стоит комментировать очевидное.

Специфические требования к программам указаны в заданиях.

Пример оформления исходного текста программы на языке Си.

/* lab_01.c – Листинг программы для 1-ой лабораторной работы

****************************************************************************************

* Filename: lab_01.c

* Abstract: This is sample C-program

* Description:

* Creation Date: 2013 / 09 / 10

* Author:

* Notes / Platform / Copyrights: OS Linux, FreeWare

****************************************************************************************/

#include <stdio.h>

#define myPi 3.14159265358979323846

char msg1[] = "Nizhniy Novgorod Technical University\n"

"Study work number 1. Task number 1.\n"

"Performed student Ivanov Ivan, 13-IVT-3."

/* ****************************** Main function ***********************************/

int main(void)

{

/******************************* Local variables ***********************************/

int intVar1=10, intVar2=5;

/****************************** Code Segment ***********************************/

printf(msg1);

printf(“\n constant PI = %lf”, myPi);

printf(“\n%d + %d = %d\n”, intVar1, intVar2, (intVar1+intVar2));

* * * * * *

printf(“\n ========== End of program ==========\n”);

return 0;

}