Правила записи программы на языке Си

Программа перед обработкой компьютером должна быть помещена в файл на диске. Обычно этот файл имеет расширение <.c>.

Рассмотрим типичную структуру файла с программой на языке Си и правила его оформления на следующем простом примере:

/* Включить описания функций стандартного ввода-вывода */

#include <stdio.h>

/* Включить описания математических функций */

#include <math.h>

/* Другие включаемые файлы */

.

.

.

/* Собственно текст программы */

void main( void ) /* <-- заголовок главной функции */

{

float num; /* <-- описание типов данных */

/* Исполняемые операторы -* */

num = 2.345; /* Присвоим переменной num

значение 2.345 */

printf( " sin(%f) = %f\n", num, sin(num) ); /* Вывод на экран */

}

Любой файл начинается с директив #include, вставляющих в текст программы так называемые заголовочные файлы, которые содержат описания функций, используемых в этом файле. В нашем примере это описания стандартных функций ввода-вывода <stdio.h> и математических функций <math.h>.

Далее следует заголовок главной функции программы main, операторы описания типов данных и исполняемые операторы.

Директивы #include должны всегда начинаться с новой строки, остальные же операторы программы могут иметь произвольное положение в файле вплоть до записи в одну строку. При записи не допускается разрывать слова, числа, двухсимвольные операции.

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

В любом месте программы, там, где может стоять пробел, допускается записывать комментарии.

/* Это комментарий */

// Это тоже комментарии.

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

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

всегда необходимы вводные комментарии, в которых указывается назначение программы, ее автор, дата написания и изменения, краткое описание алгоритма, входных и выходных данных, основных переменных и вызываемых функций;

комментарии должны содержать дополнительную информацию, а не перефразировать программу;

комментарии должны быть расположены так, чтобы программа не была менее наглядной;

неправильные комментарии хуже, чем их отсутствие.

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