2.8 Разработка программного обеспечения

Написание программ на скорую руку даёт быстрый, но сомнительный результат; дисциплинированный подход, напротив, обеспечивает более высокое качество с меньшими временными затратами.

Процесс реализации модулей можно разделить на несколько этапов:

1. Определить стандарты кодирования в рамках проекта.

2. Реализовать каждый класс каждого пакета через кодирование методов, определённых требованиями в детальном проектировании.

3. Осуществить инспектирование класса.

4. Произвести набор модульных тестов.

5. Выпустить пакет и классы для интеграции в разрабатываемое приложение.

Популярное представление о программировании как о процессе подготовки текста программы для компиляции на самом деле отражает лишь незначительную часть общей картины. Действительной целью написания программы является создание правильного кода, то есть такого кода, который полностью соответствует сформулированным для неё требованиям. Компиляторы только проверяют корректность синтаксиса и генерируют объектный код. За правильность программы отвечает человек, поэтому нужно убедиться в правильности своей программы до того, как её компилировать.

Рассмотрим один из способов реализации кода:

1. Спланируйте структуру вашего кода

2. Проинспектируйте проект и структуру

3. Наберите код

• пока не компилируйте

• попробуйте использовать методы, перечисленные ниже

• примените необходимые стандарты

• кодируйте таким способом, который будет легче всего проверить

4. Проинспектируйте код, но пока не компилируйте

5. Откомпилируйте код:

• исправьте синтаксические ошибки

6. Протестируйте код

Следование приведённому способу гарантирует написание качественного программного кода. Не менее важным аспектом является его читабельность при коллективной разработке программного обеспечения. Использование стандартов способствует дисциплине программирования и повышает как читаемость, так и переносимость программ. Рассмотрим наиболее значимые моменты соглашения о кодировании. Указанные соглашения не являются строгим стандартом, но отражают генезис правил «чистого кодирования».

Соглашение об именах

1. Именуйте объекты с помощью конкатенации слов, например fileSize. Такие имена легко понять, и они экономят место. Исключения со знаком подчёркивания оставляются на выбор программиста (вместо aAAAAAAuto лучше написать a_AAA_AA_Auto).

2. Начинайте имена классов с большой буквы. Так вы будете легко отличать их от имён переменных. Иногда для именования классов проекта полезно выбрать префикс, чтобы отличать ваши классы от классов сторонних разработчиков (PwUnit, ZnChannel, CString, MwString).

3. Имена переменных начинайте с маленькой буквы.

4. Используйте в именах констант прописные буквы, например Я_ЕСТЬ_КОНСТАНТА (CYCLE_REQUEST_TIME_OUT, CHANNEL_BOX_SIZE ).

5. Для методов доступа используйте имена, начинающиеся с get, set и is, например, getName(), setName(), isBox() - возвращает тип boolean.

6. Добавьте стандартные дополнительные методы get и set для коллекций, например insertIntoName(), removeFromeName(), newName().

7. Договоритесь о соглашении для параметров. Можно использовать префиекс а, например sum(int aNum1P, int aNum2P), или суффикс P, например sum( int Num1P, int Num2P)

Договоритесь о следующих стандартах внутри методов:

1. выполняйте только одну операцию на одной строке

2. старайтесь чтобы ваши методы помещались на один экран

3. блоки в командах if, else, while должны состоять из одной строки в которой обычно содержится вызов функции.

4. для обеспечения принципов «защещённого» кодирования следует проверять все входные параметры на корректность.

Применяя этот минимальный набор умолчаний вы сможете значительно улучшить восприятие вашего кода сторонними специалистами и подготовить его для повторного использования.

Методические указания

В рамках сформированных проектных групп провести собрание «соглашения о кодировании». На координирование соглашений и способ их выработки следует выделить ограниченное время. Например, можно поручить члену команды разработать черновик соглашений и отправить его по электронной почте остальным членам команды для отзывов. Затем, на собрании обсудить замечания и утвердить набор соглашений в форме документа.

В процессе написания кода осуществлять мониторинг чистоты и защищённости кода посредством инспектирования и модульного тестирования.