Объектно-ориентированное программное обеспечение Документация

Документация по программам предоставляет разработчикам и пользователям программ полезное описание того, что делает программа, как она работает, как она построена и как она должна использоваться. Например, руководство пользователя демонстрирует, как пользователи должны взаимодействовать с программным продуктом; в то время как проектный документ помогает разработчикам в процессе эволюции и сопровождения программного обеспечения. Основная задача состоит в том, чтобы построить автоматизированный инструмент, способный создавать по требованию динамическую документацию исходного кода программного обеспечения. В этой книге представлен автоматический подход, называемый Al-Msie'deen подход для создания по требованию документации программного обеспечения для программного кода. Новизна этого подхода заключается в создании динамической документации по программному коду на уровне пакетов, классов, атрибутов и методов. Документация по коду - это письменные текстовые или иллюстрированные диаграммы, представляющие информацию обо всех уровнях детализации кода, от уровня пакетов до уровня методов.