Интерфейсы периферийных устройств. Ключев А.О - 280 стр.

UptoLike

ВУЗ: 

Университет ИТМО | Санкт-Петербург

Составители: 

Рубрика: 

279
// ошибки использования графики по ее коду
unsigned char* GraphErrorMsg( short ErrCode );
Б. В любых идентификаторах каждое слово, входящее в идентификатор,
разделять символом “_”, при этом все буквы – маленькие.
Например:
float next_x, last_x; // следующая и предыдущая итерация
char beep_on_error; // подавать ли звуковой сигнал при
// неправильном вводе пользователя?
unsigned char file_name[ 20 ];
// стандартная функция модуля Graph; выдает описание
// ошибки использования графики по ее коду
unsigned char* graph_error_msg( short err_code );
Г.2 Соглашения по самодокументируемости программ
Г.2.1 Комментарии
А. Комментарии в теле программы следует писать на русском языке и по
существу так, чтобы программист, не участвовавший в разработке
программы (но имеющий опыт работы на языке Си), мог без особого
труда разобраться в логике программы, и, при необходимости,
сопровождать данный программный продукт.
Б. Рекомендуется комментарии к программе писать после символов //, а /*
и */ использовать при отладке программы как "заглушки" участков
программного кода.
Г.2.2 Спецификация функций
Для каждой пользовательской функции должна быть описана в виде
комментария спецификация, содержащая следующую информацию [96]:
• Назначение функции;
• Описание семантики параметров-значений (параметров, передаваемых
по значению).
• Описание семантики
параметров-переменных (параметров,
передаваемых по ссылке).
• Описание семантики возвращаемого значения.
Например:
/////////////////////////Gauss//////////////////////////////
// Решение системы линейных алгебраических уравнений
// методом Гаусса.
// Вход:
// A - матрица коэффициентов системы;
// B - столбец свободных членов системы;
// Eps - точность вычислений.
// Выход:
// X - вектор решения;
// HasSolution - флаг, устанавливаемый в True, если

Страницы