Результат использования этих методик организации кода таков: когда Оман и Кук попросили группу опытных программистов выполнить одну задачу на сопровождение программы, среднее время выполнения этой задачи в случае программы из 1000 строк составило только около трех четвертей от времени, потребовавшегося для решения той же задачи при традиционной организации исходного кода (Oman and Cook, 1990b). Более того, при сопровождении кода, задокументированного в соответствии с Книжной парадигмой, программисты получили в среднем на 20% более высокие оценки, чем при сопровождении кода, задокументированного традиционным образом. Оман и Кук пришли к выводу, что, обращая внимание на принципы структурирования книг, можно улучшить понятность кода на 10-20%. В исследовании, проведенном в Университете Торонто, были получены похожие результаты (Ваескег and Marcus, 1990).

Книжная парадигма подчеркивает важность создания документации, объясняющей и высокоуровневую, и низкоуровневую организацию программы.

32.6. Стандарты IEEE

Ценными источниками сведений о документации, не относящейся к уровню исходного кода, являются стандарты разработки ПО, принятые Институтом инженеров по электротехнике и электронике (Institute for Electric and Electrical Engineers, IEEE). Стандарты IEEE разрабатываются группами профессионалов и ученых - экспертов в конкретной области. Каждый стандарт содержит резюме описываемой стандартом области и обычно включает обзор документации, уместной для данной области.

В разработке стандартов принимают участие несколько национальных и международных организаций. Ведущая роль в определении стандартов разработки ПО принадлежит группе IEEE. Некоторые стандарты совместно приняты Международной организацией по стандартизации (International Standards Organization, ISO), Альянсом электронной промышленности (Electronic Industries Alliance, EIA) и Международным инженерным консорциумом (International Engineering Consortium, lEC).

Названия стандартов включают номер стандарта, год его принятия и само название. Так, «1ЕЕЕ/Е1А Std 12207-1997, информационные технологии - процессы жизненного цикла ПО» - это стандарт номер 12207.2, принятый в 1997 году IEEE и EIA.

Ниже я указал некоторые национальные и международные стандарты, в наибольшей степени относящиеся к проектам разработки ПО.

Стандартом верхнего уровня является международный стандарт «ISO/IEC Std 12207, Information Technology - Software http:/yc€26.com/3266 Life Cycle Processes», определяющий схему разработки программных проектов и управления ими. В США этот стандарт был принят как «ШЕЕ/ EIA Std 12207, Information Technology-Software Life Cycle Processes».

Стандарты разработки ПО

IEEE std 830-1998 - рекомендуемая методика составления

спецификаций требований к ПО http: cc2e.com/3273

ШЕЕ Std 1233-1998 - руководство по разработке спецификаций требований к системе

IEEE Std 1016-1998 - рекомендуемая методика описания проекта ПО IEEE Std 828-1998 - стандарт планов управления конфигурацией ПО IEEE Std 1063-2001 - стандарт пользовательской документации IEEE Std 1219-1998 - стандарт сопровождения ПО

Стандарты контроля качества ПО

IEEE Std 730-2002 - стандарт планирования контроля ка-ЬПр:/Шыт1Ш чества ПО

IEEE Std 1028-1997 - стандарт обзоров ПО IEEE Std 1008-1987 (R1993) - стандарт блочного тестирования ПО IEEE Std 829-1998 - стандарт документирования тестов ПО IEEE Std 1061-1998 - стандарт методологии метрик качества ПО

Стандарты управления

IEEE Std 1058-1998 - стандарт планов управления проек-тршгыатшт ами разработки ПО

IEEE Std 1074-1997 - стандарт разработки процессов жизненного цикла ПО

IEEE Std 1045-1992 - стандарт метрик продуктивности ПО

IEEE Std 1062-1998 - рекомендуемая методика приобретения ПО

IEEE Std 1540-2001 - стандарт процессов жизненного цикла ПО - управление риском

IEEE Std 1490-1998 - руководство (заимствование стандарта PMI) к своду знаний по управлению проектами (РМВОК)

Обзор стандартов

Обзоры стандартов можно найти в двух источниках, указан-

тммт

IEEE Software Engineering Standards Collection, 2003 Edition. New w.. и л /лплч York, NY: Institute of Electrical and Electronics Engineers (IEEE).

Этот всесторонний труд содержит 40 самых новых стандартов разработки ПО ANSI/IEEE на 2003 год. Каждый стандарт включает план документа, описание каждого компонента плана и обоснование этого компонента. Этот документ включает стандарты планов контроля качества, планов управления конфигурациями, документов тестирования, спецификаций требований, планов верификации и проверки, описаний проектирования, планов управления проектами и пользовательской документации. Данная книга представляет собой квинтэссенцию опыта сотен лучших специалистов в своих областях и была бы выгодным приобретением практически при любой цене. Некоторые из стандартов доступны и отдельно. Все стандарты можно заказать у организа-

ции IEEE Computer Society из города Лос-Аламитос, шт. Калифорния, и на сайте www.computer.org/cspress.

Moore, James W. Software Engineering Standards: A Users Road Map. Los Alamitos, CA: IEEE Computer Society Press, 1997. Myp приводит обзор стандартов IEEE разработки ПО.

Дополнительные ресурсы

Кроме стандартов IEEE, есть и другие источники информации о документировании программ. bttp: cc2e.coni/3208

Spinellis, Diomidis. Code Reading: The Open Source Perspective.

Boston, MA: Addison-Wesley 2003. Эта книга является праг- Интвресно, сколько 8бя*1ких пи-матичным исследованием методик чтения кода. В ней вы сателей никогда не читали дру-найдете советы по поиску нужного кода и чтению больших " авторов, сколько великих - г gi художников никогда не изуча-объемов кода, сведения об инструментах, облегчающих чте- ,роизвбденш других шсте-ние кода, и массу полезных рекомендаций. pos, сколько еысококвалйфици-SourceForge.net. Уже много лет обучению разработке ПО рованньх хирургов никогда не

препятствует проблема поиска реальных примеров готового "" за плечом колле /г- г- г- ги.., И все же именно этого мы

кода, которые можно было бы обсудить со студентами. Мно- ожидаем от программистов, гие люди быстрее всего учатся на реальных примерах, од- j j нако большинство реальных программ является собственностью создавших их компаний. Благодаря Интернету и ПО с открытым исходным кодом эта ситуация улучшилась. Web- mip: cc2e.com/3215

сайт Source Forge содержит код тысяч программ, написанных на С, С++, Java, Visual Basic, РНР, Perl, Python и других языках, причем весь этот код вы можете загрузить из сети совершенно бесплатно. Вы можете проанализировать реальные примеры, гораздо более объемные, чем примеры, приведенные в этой книге. Для начинающих программистов, не имевших ранее дела с объемными примерами готового кода, этот Web-сайт окажется особенно полезен как источник и хороших, и плохих методик кодирования.

Sun Microsystems. «How to Write Doc Comments for the Javadoc

Tool», 2000. В этой статье (http: javasun.com/j2se/javadoc/ mtp: cc2e.com/3222

wntingdoccomments/) описывается применение инструмента

Javadoc для документирования программ Java. Она включает детальное описание разметки комментариев с использованием нотации стиля @tag, 2. также многие конкретные советы по написанию самих комментариев. Конвенции Javadoc являются, наверное, наиболее развитыми из нынешних стандартов документирования на уровне кода.

Ниже указаны источники информации о других аспектах документирования ПО.

McConnell, Steve. Software Project Survival Guide. Redmond, WA: Microsoft Press, 1998. В этой книге описывается документация, необходимая в критически важных проектах среднего размера. На Web-сайте книги вы можете найти много шаблонов документов.