3.2 Приемы оформления кода
Хороший код должен быть красиво оформлен.
Правило 1. Написание комментариев
Использовать комментарии нужно обязательно, но не внутри операторов.
Комментарии никак не влияют на создание исполняемой программы и просто пропускаются компилятором. Назначение комментариев состоит в том, чтобы облегчить понимание алгоритма программы при чтении её исходного текста. Оформить текст в виде комментария можно одним из следующих способов:
1) короткий текст – поместив символы // перед текстом строки,
//оператор getch(); заставит программу getch();
//ждать нажатия клавиши
2) текст, занимающий несколько строк – заключив текст в скобки вида /* и */, например,
/**************************************************/
/* функция оформления текста */
/**************************************************/
Правило 2. Определение переменных и функций
При составлении имен желательно придерживаться какого-либо стиля – CamelCase, under_scope, MixedCase и др.
Распространенным в языке Си является стиль, основанный на использовании символа подчеркивания для разделения слов в именах переменных и функций.
Все объекты программы должны быть названы обоснованными именами, говорящими о назначении того или иного объекта.
Переменные следует писать строчными буквами. Но не следует использовать символ подчеркивания в начале имени, так как это предусмотрено для служебных констант и функций.
Пример.
counter, increment - счетчик
name, lastName - имя, фамилия
home_phone – домашний телефон
Константы рекомендуется писать в верхнем регистре.
Пример.
SIZE, POINT, BOOK
Для именования переменных нужно использовать существительные, а для именования функций – глаголы (либо глагол + существительное), т. к. это действие.
Названия функций должны отражать возвращаемое значение.
Пример.
cos(x) – вычислить косинус
play Song() – воспроизвести музыку
print Array()– вывести значения массива
Шестнадцатеричные константы следует писать заглавными буквами. При этом префикс константы должен быть написан строчной буквой ‘x’.
Пример.
0xFF1234AB
При указании типа данных для целочисленных констант или констант с плавающей точкой суффиксы f, l, u и e следует писать строчными буквами.
Пример.
0.5f
10e10
Правило 3. Форматирование кода
Каждое объявление данных необходимо размещать на отдельной строке. Группировать следует только по логической взаимосвязи.
Пример.
double radius;
double sq_round;
intx1,y1;//координат точек
Операторы (+, –, *, /, = и т.п.) следует отделять от операндов одним пробелом. Логический оператор отрицания (!) следует писать слитно с операндом.
Длина строк программы не должна превышать ширины экрана (80 символов).
3.3 Пример конструирования программы
Пример 1. Вывод информации о допустимых диапазонах представления переменных целого типа.
Минимальные и максимальные значения переменных заданы в заголовочном файле limits.h в виде переопределения #define, вида:
#define SHRT_MIN (-32768) /* minimum (signed) short
#define SHRT_MAX 32767 /* maximum (signed) short
#define USHRT_MAX 0xffff /* maximum unsigned short
Поэтому в программе достаточно использовать эти определения.
#include < stdio.h > //Для printf и puts
#include < limits.h >
#include < locale.h >
int main (void)
{
setlocale(LC_ALL, "RUS");
printf ("Основные типы данных\n");
printf ("Целые числа типа int от %dдо %d.\n", INT_MIN, INT_MAX);
printf ("Целые числа типа short от %dдо %d.\n",INT_MIN, INT_MAX);
printf ("Целые числа типа long от %ld до %ld.\n",LONG_MIN , LONG_MAX);
printf ("Целые числа типа longlong от %lld до %lld.\n",LLONG_MIN , LLONG_MAX);
system("pause");
return 0;
}
Результаты работы программы представлены ниже на рис.3.1.
Рис.3.1. Результат работы программы
Обратите внимание на использование специальных спецификаторов формата для вывода переменных типа long.
Пример 2. Ввод и вывод значений различного типа.
int main()
{
char c1;
short s1;
int i1;
long L1;
float f1;
double d1;
printf("input char >"); scanf("%c", &c1); printf(" %c\n", c1);
printf("input short>"); scanf("%hd", &s1); printf(" %hd\n", s1);
printf("input int >"); scanf("%d", &i1); printf(" %d\n", i1);
printf("input octal>"); scanf("%o", &i1); printf(" %o\n", i1);
printf("input hexa >"); scanf("%x", &i1); printf(" %x\n", i1);
printf("input long >"); scanf("%ld", &L1); printf(" %ld\n", L1);
printf("input float>"); scanf("%f", &f1); printf(" %f\n", f1);
printf("input double>"); scanf("%lf", &d1);printf(" %lf\n", d1);
return 0;
}