caxapa.ru :: что понимается под достаточным уровнем? Кому-то достаточно doxygen + graphviz. Если для ваших диаграмм (не зависимостей, которые doxygen стоит сам по исходникам) будет достаточно средств graphviz, то это, имхо, лучший вариант. Прям в комментарии

Alex B. (27.10.2008 16:30, просмотров: 198) ответил Shura на Вот мне именно надо, чтоб соответствовали. И время уделять придётся. Вопрос как раз в оптимизации этого времени - чтоб не слишком много уходило, но при этом оставался достаточный уровень документированности.

что понимается под достаточным уровнем? Кому-то достаточно doxygen + graphviz. Если для ваших диаграмм (не зависимостей, которые doxygen стоит сам по исходникам) будет достаточно средств graphviz, то это, имхо, лучший вариант. Прям в комментарии волшебным словом \dot Между делом - после дня разбирания и ебли dot пишется прям сходу. Довольно удобно, если действительно нужно интегрировать дополнительную инфу именно в исходник

Согласуйте импеданс!

Ответить

- еще как вариант - Understand for C/C++ - но это все таки больше для анализа, нежели для документирования. - Alex B.(27.10.2008 16:32, ссылка)
  - Не подходит, софт на ассемблере в основном - Shura(27.10.2008 16:34)
    - Если для продукции Atmel, то Algorithm Builder :) бомж(27.10.2008 22:55)
    - хм. А что тогда значит "с исходниками все ясно"? Я думал doxygen и юзаете, раз все ясно... - Alex B.(27.10.2008 16:37)
      - Значит, что исходники просто сдаются в архив. Разобраться с ними никто, кроме аффтара не может, да и сам аффтар по истечении времени в них разобраться не может. Отседова и вопрос возник - Shura(27.10.2008 16:41)
        
        ну тады ой. Если бы на С/С++ - то юзать доксиген и не парится. Все равно, конечно, осталась бы проблема лени и похуизма, но как я понял, за аксиому берем что все молодцы. Но все равно согласен с she, в идеальный порядок все привести не удастся =) - Alex B.(27.10.2008 16:55)
        
        Doxygen и другие ф топку. Сильно зесераются исходники. У нас от него остались только шапочки для файлов и функций. diper(255 знак., 27.10.2008 17:47)
        
        да-да, я тоже так думал. Вы путаете комментирование и документирование. Если у вас документация никак не связана с исходниками, то держать ее в актуальном состоянии это ацкий труд, проще будет совсем на это болт забить. Alex B.(543 знак., 27.10.2008 17:58)
        
        ... если модуль сложный, то описание его работы расписано в шапке. Тоже касается функции. Размеры не смущают. Держится в более менее актуальном состоянии. Прелипил шапку одного модуля, текст не важен, главное количество :) diper(27.10.2008 18:10)
        
        есчо раз - вы говорите про комментирование исходников. Я про документирование - т.е. про отдельный от исходников документ, который им [теоретически] соответствует. Alex B.(588 знак., 27.10.2008 18:19)
        
        Усе понял. У нас как то не сложилось написание отдельных документов. Обычно на проект (если это одна функционально законченная железка) разработчик для себя составляет один документ в котором расписаны неокторые ньюансы, которые в исходник запихать diper(381 знак., 27.10.2008 18:31)
        
        во-во. "Когда уходит разработчик" - это один из вариантов, когда нужна документация... - Alex B.(27.10.2008 18:37)
        
        Дык вот и вопрос - какая документация? - Shura(28.10.2008 10:52)
        
        Да никакая ;) AlexandrY(325 знак., 28.10.2008 20:43)
        
        БДСМом увлекаетесь? :) - diper(28.10.2008 21:53)
        
        С чего-то надо начать хотя-бы, к идеалу будем приближаться итерациями :-) - Shura(27.10.2008 16:57)

Микроконтроллеры