Doxygen: документирование
Добавлено: 11 мар 2024, 11:08
Документирование создаваемого программного кода - это составная часть технологии, не менее важная, чем само создание кода и его тестирование и отладка.
Беда в том, что разработчики об этом особенно не хотят знать
И это особенно актуально при переходе к опенсорсной модели ...
Потому что некоторые проприетарные продукты имели шикарную документацию (к Microsoft и Windows это лирическое отступление не имеет отношения ).
Примеры такой шикарной документации ... былых времён:
1. Система документирования IBM 360 ... позже переведенная и адаптированная к сеейству ЕС ЭВМ - документация по ОС/ЕС составляла ... "2 метра на книжной полке", это не менее 50 или 70 книг, некоторые из которых по 10-15 страниц, но основополагающие: FORTRAN, PL/1 ... имели по 300-400-500 страниц.
2. Документация операционной системы реального времени QNX 6 Neutrino - это онлайн иерархическая документация ... но образца такой детализации описаний по POSIX (UNIX) стандартам я вообще не видел ... особенно по расширениям POSIX реального времени: 1003b, 1003g и др.
Для проприетарного ПО полнота и прозрачность документации - это был важный фактор её продаваемости
Для опенсорс как раз отсутствие документации становится заметным фактором финансового благополучия производителя: зараьоток теперь происходит не с продаж ПО или лицензий, а с последующих консультаций по использованию, внедрению и техподдержке.
Блестяший пример тут RedHat - ставший крупнейшей финансовой империей на Linux ... и упадок и нищета IBM из мира проприетарного (а когда-то в IT было 2 актора, участника: IBM + все остальные ).
Про это всё эсть у нас уже тема здесь обсуждения Бизнес-модели в IT производстве - там много деталей...
А сейчас, эта тема, она интересует меня относительно средства автодокументирования Doxygen.
Беда в том, что разработчики об этом особенно не хотят знать
И это особенно актуально при переходе к опенсорсной модели ...
Потому что некоторые проприетарные продукты имели шикарную документацию (к Microsoft и Windows это лирическое отступление не имеет отношения ).
Примеры такой шикарной документации ... былых времён:
1. Система документирования IBM 360 ... позже переведенная и адаптированная к сеейству ЕС ЭВМ - документация по ОС/ЕС составляла ... "2 метра на книжной полке", это не менее 50 или 70 книг, некоторые из которых по 10-15 страниц, но основополагающие: FORTRAN, PL/1 ... имели по 300-400-500 страниц.
2. Документация операционной системы реального времени QNX 6 Neutrino - это онлайн иерархическая документация ... но образца такой детализации описаний по POSIX (UNIX) стандартам я вообще не видел ... особенно по расширениям POSIX реального времени: 1003b, 1003g и др.
Для проприетарного ПО полнота и прозрачность документации - это был важный фактор её продаваемости
Для опенсорс как раз отсутствие документации становится заметным фактором финансового благополучия производителя: зараьоток теперь происходит не с продаж ПО или лицензий, а с последующих консультаций по использованию, внедрению и техподдержке.
Блестяший пример тут RedHat - ставший крупнейшей финансовой империей на Linux ... и упадок и нищета IBM из мира проприетарного (а когда-то в IT было 2 актора, участника: IBM + все остальные ).
Про это всё эсть у нас уже тема здесь обсуждения Бизнес-модели в IT производстве - там много деталей...
А сейчас, эта тема, она интересует меня относительно средства автодокументирования Doxygen.