- •Реферат
- •Содержание
- •1 Конструкторский раздел 7
- •2 Технологический раздел 48
- •3 Технико-экономический раздел 71
- •4 Раздел охраны труда и окружающей среды 84
- •Определения, обозначения и сокращения
- •Введение
- •1 Конструкторский раздел
- •1.1 Анализ предметной области и постановка задачи
- •1.2 Проектирование структуры комплекса
- •1.3 Проектирование пользовательского интерфейса
- •1.4 Реализация программного комплекса
- •1.4.2.1 Стандарт кодирования для языка Python
- •1.4.2.2 Стандарт кодирования для языка php
- •1.4.2.3 Результаты сверки стандартов кодирования
- •2 Технологический раздел
- •2.1 Выбор и обоснование средств разработки
- •2.2 Разработка эксплуатационной документации
- •3 Технико-экономический раздел
- •3.1 Расчёт трудоёмкости и себестоимости комплекса
- •3.1.2.1 Расчёт затрат на материалы и комплектующие изделия
- •3.1.2.2 Расчет заработной платы на создание программного средства
- •3.1.2.3 Расчет единого социального налога
- •3.1.2.4 Расчет накладных расходов
- •3.1.2.5 Расчет затрат на содержание и эксплуатацию вычислительных средств
- •3.1.2.6 Расчёт удельного веса видов затрат
- •3.1.2.7 Себестоимость разработки программного средства
- •4 Раздел охраны труда и окружающей среды
- •4.1 Анализ и нормирование овпф, их воздействие на пользователя
- •4.2 Расчёт заземления
- •Расстояние между стержнями:
- •4.3 Пожарная безопасность
- •4.4 Экологическая безопасность
- •4.4.1. Утилизация компьютерной техники.
- •Заключение
- •Список использованных источников
- •Приложение а. Исходный код программного комплекса Webipt
- •Приложение в. Возможности утилиты iptables
- •В.1 Принцип работы шлюза
- •В.2 Обрабатываемые параметры
- •В.3 Действия netfilter
- •В.4 Синтаксис команд iptables
- •В.5 Сохранение и восстановление конфигурации.
- •В.6 Установка дополнительных модулей
1.4.2.1 Стандарт кодирования для языка Python
Для языка Python принято использовать стандарт кодирования PEP8 [19].
Форматирование:
использовать 4 пробела для отступа, не использовать табуляцию;
максимальная длина строки 79 символов; для разрыва строки использовать отступы или символ «\»;
функции верхнего уровня и определения классов отделять двумя пустыми строками;
определения методов внутри класса отделять одной пустой строкой;
использовать дополнительные пустые строки для логической группировки методов;
кодировка файлов должна быть UTF-8;
каждый импортируемый модуль должен начинаться с новой строки;
порядок импортов: стандартные модули, сторонние модули, локальные модули приложения;
пустая строка между каждой группой импортов;
избегать лишних пробелов внутри скобок; перед запятыми, точкой с запятой и двоеточиями;
избегать лишних пробелов перед скобками с аргументами функций и скобками с индексами;
избегать больше чем одного пробела между операторами (= - + и т. д.);
использовать одиночный пробел для выделения операторов;
избегать пробелов вокруг '=', который используется для параметров по-умолчанию и keyword-аргументов;
обновлять комментарии вместе с кодом;
комментарии должны быть на английском языке или транслитерацией;
Соглашение по именованию:
избегать имён из одиночных l, O, I;
для модулей и пакетов использовать короткие имена, все символы которых — строчные буквы;
для имён классов первая буква каждого значимого слова должна быть заглавной;
для функций использовать либо имена из строчных букв, разделяя значимые слова подчёркиваниями, либо используя смешанный регистр (значимые слова слитно; первая буква каждого слова, начиная со второго — заглавная);
для методов используйте имена из строчных букв, разделяя значимые слова подчёркиваниями;
для внутренних методов и переменных добавляется подчёркивание в начале имени;
Стиль кодирования:
для проверки на Noneиспользоватьisилиis not, не использовать операторы сравнения;
использовать исключения основанные на классах, т.е. наследованные от Exception;
использовать методы класса stringвместо строковых функций;
использовать ''.startswith()и ''.endswith()вместо вырезки из строк для проверки префиксов и суффиксов;
использовать isinstance()для проверки типа;
не сравнивать булевы переменные с TrueиFalse.
1.4.2.2 Стандарт кодирования для языка php
Для языка PHP принято использовать стандарты компании Zend [20].
Форматирование:
для файлов, содержащих только PHP-код, закрывающийся тег ("?>") не разрешен;
для отступа использовать 4 пробела. Не использовать символ табуляции;
рекомендуемая максимальная длина строки: 80 символов; предельная — 120 символов;
перевод строки только символом перевода строки (LF), как принято в UNIX-системах;
Соглашение по именованию:
имена классов и интерфейсов состоят из значимых слов, начинающихся с заглавных букв и разделённых подчёркиваниями; использование чисел не рекомендуется;
для имён файлов допустимы буквенно-числовые символы, символы нижнего подчеркивания и дефис;
в именах функций и переменных значимые слова идут слитно; первая буква каждого слова, начиная со второго — заглавная (т.н. «верблюжья» нотация);
имена методов доступа должны иметь префиксы getилиset;
для переменных - членов классов, определенных с помощью префиксов области видимости "private" или "protected", первым символом имени должно быть подчеркивание;
имена функций должны быть настолько говорящими, насколько это практично;
короткие имена переменных, такие как "$i" и "$n" не приветствуются нигде, кроме как в контексте маленьких циклов (не более 20 строк кода);
имена констант должны быть в верхнем регистре, возможно использование подчёркивания.
Стиль кодирования:
использование короткого начального тега «<?» недопустимо;
когда строка не содержит подстановок переменных и апострофов, для её обрамления должны использоваться апострофы;
конкатенация строк осуществляется с помощью символа «.» и пробелов вокруг него;
отрицательные числа в качестве индексов массивов запрещены;
при описании ассоциативных массивов необходимо помещать каждую пару «ключ => значение» на отдельной строке с выровненными ключами и значениями;
классы должны определяться по следующей схеме:
фигурная скобка всегда пишется на следующей строке под именем класса;
каждый класс должен иметь блок документации (doc-блок) в соответствии со стандартом PHPDocumentor;
код внутри класса должен иметь отступ в четыре пробела;
только один класс разрешен внутри одного PHP-файла;
размещение дополнительно кода в файле с классом разрешено, но не приветствуется. В таких файлах, две пустые строки должны разделять класс и дополнительный PHP-код;
любые переменные, определенные в классе, должны быть определены в начале класса, до определения любого метода;
ключевое слово varне разрешено. Члены и методы класса должны всегда определять их область видимости, используя ключевое словоprivate,protectedилиpublic. Доступ к переменным-членам класса напрямую используя префиксpublicразрешено, но не приветствуется в пользу методов доступа (set/get).
при описании функции, открывающая фигурная скобка пишется на следующей строке под именем функции;
пробелы между именем функции и круглой скобкой для аргументов отсутствуют;
передача по ссылке допустима только в определениях функций, но не во время вызова;
управляющие структуры, основанные на конструкциях if,else,elseif и switch должны иметь один пробел до открывающей круглой скобки условия, и один пробел после закрывающей круглой скобки. Открывающаяся фигурная скобка пишется на той же строке, что и условие. Закрывающаяся фигурная скобка пишется на отдельной строке. Все содержимое между скобками пишется с отступом в четыре пробела. Фигурные скобки должны ставиться в любом случае;
при применении конструкции switch, case-выражения, не содержащие break или return, должны содержать комментарий "// break intentionally omitted".