Методические указания по подготовке и защите отчетов на специализации "Прикладная математика. Системное программирование". Кленин А.С. - 20 стр.

     Исходный код
      Исходный код системы обычно не является частью отчёта и не демонстрируется во
время защиты. Однако руководитель перед защитой просматривает исходный код с целью
определения общего качества кодирования и степени самостоятельности защищающегося,
анализа личного вклада каждого участника в совместную разработку.
      Поскольку выработка стиля кодирования является важной компонентой образования
на специальности «Системное программирование», правильное оформление исходного ко-
да является необходимым условием для допуска к защите работы.
      Требования к оформлению исходного кода могут определяться корпоративными
стандартами организации-заказчика. Этот факт должен быть отражен в тексте работы, а
сами требования — включены в список литературы.
      При отсутствии внешних требований следует придерживаться приведённых ниже ре-
комендаций, а также рекомендаций, изложенных в литературе (см., например, [7]). В лю-
бом случае, принятые соглашения о кодировании должны быть документированы в отчёте,
в разделе «Общие требования» либо «Проект».

     Форматирование кода
     Исходный код на должен быть оформлен в едином в пределах системы стиле. Фор-
матирование кода включает:
     • выделение блочной структуры — все блоки должны быть выделены отступом от
        1 до 8 пробелов (рекомендуется 2);
     • использование пробелов в выражениях и операторах (рекомендуется расставлять
        пробелы максимально близко к правилам естественного языка, например, после
        запятых и точек с запятыми, вокруг знаков операций, снаружи скобок, не являю-
        щихся вызовом функции);
     • группировка операторов по строкам (рекомендуется размещать не более одного
        оператора в строке);
     • разбиение длинных операторов на несколько строк (рекомендуется выделять пе-
        ренесённую часть отступом);
     • форматирование табличных структур.

     Именование объектов
    Объекты, используемые в программе, должны именоваться согласно единой схеме,
включающей соглашения о следующем:
    • разделение слов внутри идентификатора — при помощи подчёркивания либо на-
       писания каждого слова с заглавной буквы;
    • оформление идентификаторов различных видов (имён констант, переменных,
       функций, классов), использование заглавных и прописных букв, специальных
       префиксов;
    • использование частей речи и устойчивых словосочетаний (например, имена логи-
       ческих функций начинаются на «is»);
    • язык идентификаторов — рекомендуется использовать правильный английский
       либо, для систем которые это допускают (например, 1С или MS Access), правиль-
       ный русский язык, не рекомендуется использовать транслитерацию и некоррект-
       ные английские слова и выражения;
    • наличие в имени информации о типе (венгерская нотация).


                                            20