Skip to main content
Side panel
You are currently using guest access (
Log in
)
Технология разработки программного обеспечения (Software engineering)
Home
Courses
Архивные курсы
ТРПО (SE)
Topic 6
Документирование кода
Документирование кода
Проблема
Проблема документирования кода заключается в том, что она охватывает несколько аспектов жизни проекта:
1) Проектирование
2) Разработка
3) Тестирование
4) Сопровождение
В результате проектных решений должен быть разработан код, который их реализует. В проекте описывается что должно быть получено в общем, а код уже формализует решение в рамках выбранного языка программирования / технологии. При этом начинающие разработчики не утруждают себя написание каких-либо комментариев к тому коду, что они пишут. Когда идет творческий процесс трудно заставить себя отвлечься на какие-то глупости в виде комментариев. Да и кому они нужны, если разработчик итак знает как это будет работать, а если что-то еще и не знает - то как писать о том, что еще не известно? В результате обычно получается исходный код, который сам разработчик не может разобрать уже через небольшой период времени (неделю, месяц). Данный код проблематично тестировать, еще более проблематично его изменять. В ряде случаев разработчикам проще переписать свой код, чем внести изменения, так как они не понимают как работает их решение.
В ряде случаев начинающие разработчики используют небольшие (понятные только им) комментарии, форматируют текст. Но сопровождение такого кода так же остается сомнительным делом.
Для небольших проектов такие проблемы обычно означают что проекты закрываются и умирают. Для больших проектов наличие подобных проблем означает что производительность труда разработчиков крайне низка (из-за частых переписываний непонятных фрагментов кода, целых модулей, наличия ключевых разработчиков, которые в единственном лице могут сопровождать свой код).
◄ СУПы
Jump to...
Jump to...
Новостной форум
Источники
Курсовые
Вопросы на экзамен
Методические рекомендации
Введение в предмет
Семинар №1
Introduction
SPMP
SRS
Стратегии конструирования
USDP
XP
Software Process
Лабораторная работа №1. Системы управления проектами
Лабораторная работа №2. Анализ требований
Модели возможностей
Метрики, модель стоимости
Лабораторная работа №3. Анализ рисков
Методы анализа
Проектирование архитектуры
Software architecture
Лабораторная работа №4. Проектирование архитектуры
Лабораторная работа №5. Проектирование интерфейса
Тестирование. Организания процесса тестирования
Тестирование белого ящика
Тестирование черного ящика
Testing. Introductiion. White box technics
Testing. Black box technics
Лабораторная работа №6. Кодирование
Лабораторная работа №7. Тестирование
Управление проектами
Документирование
СУПы
Documentation
Сопровождение
Совместная разработка
Системы контроля версий
UML
Тестирование по предмету
Documentation ►
ТРПО (SE)
Home
Calendar
Data retention summary