Легенда:
новое сообщение
закрытая нитка
новое сообщение
в закрытой нитке
старое сообщение
|
- Напоминаю, что масса вопросов по функционированию форума снимается после прочтения его описания.
- Новичкам также крайне полезно ознакомиться с данным документом.
требования к исходникам 17.10.02 15:39 Число просмотров: 1263
Автор: vim Статус: Незарегистрированный пользователь
|
> интересно, где-нибудь есть список требований к исходникам > типа чтобы их можно было считать прилично выглядящими > > ... или можно здесь совместными усилиями их родить :)
Я бы сказал они должны быть такими:
1. Имена функций и переменных должны иметь смысловое значение.
Например, вместо i должно быть index.
Запрещается использовать короткие имена.
Исключение соствляют небольшие циклы на 2-3 строки кода
где допустимо использовать короткие переменные, например
for(int i = 0; i < N i++)
{
Sum = Sum + x[i];
}
2. Переменные-члены класса должны иметь особое название,
к примеру, начинаться с m_ (как это принято в MFC)
3. Не писать выражения слитно. Всегда ставить между операндами пробелы. Это повышает читабельность кода.
Плохой пример: x=2*getPos(px/2);
Хороший пример: x = 2 * getPos( px / 2 );
4. Строго соблюдать отступы.
5. Для большинства функций всегда делать шапку с комментариями
*********** Name:
Parameters:
Return value:
Description:
*********
Исключение составляют небольшие функции
в которых по названию понятно что они делают.
6. Писать комментарии в коде.
Программа всегда читается по комментариям.
7. Писать не более одного выражения в строке.
Например, недопускаются выражения типа
while (f = getValue() != 0)
8. Не использовать оператор ++ (--) внутри выражения
Вроде так
|
|
|