Настройки дизайна
  • Общие
  • Шапка
  • Главная
Базовый цвет
Свой цвет
Сайдбар
Тень на внутренних страницах
Фон логотипа в цвет сайта
Шапка сайта всегда видна
Шапка по ширине экрана
Кнопка "Оставить заявку" вместо слогана
Главное меню
Пункты меню 3-го уровня
Скрыть слайдер
"Услуги" на главной
"Тизеры" на главной
"Форма обратной связи" на главной
"Выполненные работы" на главной
"Новости" на главной
"Блог" на главной
"Партнеры" на главной

Генерирование технической документации

Внимание! Мы обновляемся! 
@twriters obmen_soobsheniyami.pngчат для технических писателей в Telegram
 Зарегистрируйтесь
Страницы: 1
RSS
Генерирование технической документации
 
Подскажите услышал такой метод, как генерация технической документации из комментариев. Кто нибудь слышал? Наши программисты такого не слышали даже.
 
Помню такую программу, но не помню как называется. использовали ее когда нужно было срочно написать документацию, срочно - порядка двух дней )). Завтра спрошу как называлась
 
Цитата
Помню такую программу, но не помню как называется. использовали ее когда нужно было срочно написать документацию, срочно - порядка двух дней )). Завтра спрошу как называлась
Очень хотелось бы взглянуть на результат  :roll:
 
Программа здесь называлась она  [b:kstgvdoa]NDOC[/b:kstgvdoa] http://ndoc.sourceforge.net/ но увы ей конец((

""В конце июля 2006 года, Кевин Даунс (Kevin Downs), основной (и единственный) разработчик NDoc — средства генерации документации для .NET — распространил заявление о том, что он прекращает свою работу над ним и вообще больше не будет участвовать в каких бы то ни было open-source проектах:

«… Разработка и выпуск NDoc 1.3 потребовали огромного объема работы, и по всем признакам, этот вклад был оценен по достоинству. К несчастью, несмотря на почти повсеместное использование NDoc, сообщество разработчиков на .Net не оказало проекту никакой поддержки, ни финансовой, ни своим вкладом в разработку. С тех пор, как версия 1.3 была выпущена, проекту было перечислено всего лишь 12 пожертвований. Фактически, если бы не подарок Олега Ткаченко, в виде подписки на MSDN, я бы даже не имел копии VS 2005, с которой мог бы продолжать работу! …»""

Вот так. А идея была в том что пока программисты програмируют, они заодно и комментарии более менее связханные пишут, потом этой программой их компилируешь, дальше уже правки:
Цитата
Очень хотелось бы взглянуть на результат  :roll:
Результат ужасный, но и внедрялось это у нас недолго, а так думаю перспективная вещь
 
Цитата


Вот так. А идея была в том что пока программисты програмируют, они заодно и комментарии более менее связханные пишут, потом этой программой их компилируешь, дальше уже правки
Результат ужасный, но и внедрялось это у нас недолго, а так думаю перспективная вещь
Идея отличная
Но вот, боюсь, ввести программу в эсплуатацию в команде (т.е. попросту заставить программистов писать осмысленные комментарии "в тему" - маловероятно.
 
Вот тут уже дело в организации самого процесса программирования, а то что наши программисты не умеют писать по стандартам, это уже другой разговор.
 
А потом техпис перейдет в состояние    
....
Были попытки..... так делать...
В начале проекта комментарии - осмысленны, разумны и грамотны...
А чем дальше.....
Так - что в памяти осталось
"Очередная приблуда"
"Зделали, а фигли - не проставилис"
"Это не трожь и ни коменть - все рухает! "
 
Цитата

А потом техпис перейдет в состояние  :lol:  :shock:  :lol:
....
Были попытки..... так делать...
В начале проекта комментарии - осмысленны, разумны и грамотны...
А чем дальше.....
Так - что в памяти осталось
"Очередная приблуда"
"Зделали, а фигли - не проставилис"
"Это  не трожь и ни коменть - все рухает! "
И помимо обычной работы техпису придется составлять и прилагать к документации еще и словарик албано-падонковской лексики  :)
 
Цитата

"Очередная приблуда"
"Зделали, а фигли - не проставилис"
"Это не трожь и ни коменть - все рухает! "
Это точно!!!
 
Оттуда же

Йа синкнулсо:
Страницы: 1
Читают тему
Рейтинг@Mail.ru