Оставить заявку

Пылесосим код!?, Как получить доку из кода

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Страницы: 1
RSS
Пылесосим код!?, Как получить доку из кода
 
Попробуйте SendCastle от Microsoft. Если не ошибаюсь то http://www.microsoft.com/downloads/en/details.aspx?familyid=e82ea71d-da89-42ee-a715-696e3a4873b2&displaylang=en
 
Если интересует по Java, то есть программулина Javadoc, кот. по т.н. аннотациям вынимает из кода комментарии и собирает их в доклеты (HTML-лина такая красивая (или не очень) получается). Эта штука бывает встроена в IDE-ки, например у меня в IDE IntellijIdea. Проблема в том, что там часть заголовков собирается на англ. языке. Поэтому если заказчики будут требовать на русском , то нужно парсить и править.
 
Всем привет!!

Сейчас столкнулся с задачей документировния "backend" части проекта. Заказчик хочет, в дополнение, док на код. Я не программер и код читать не умею, но есть информация о том, что есть тулзы, которые "читают" комменты кода и потом создают что-то типа HTML (т.е какой-то документ).

Может кто подскажет как их найти? (для кода C++, C#, жедательно Shareware).

Заранее спасибо
 
Ох, точно это тут обсуждалось и точно такие программы есть, а вот где  и какие не смог найти
 
Цитата

Сейчас столкнулся с задачей документировния "backend" части проекта. Заказчик хочет, в дополнение, док на код. Я не программер и код читать не умею, но есть информация о том, что есть тулзы, которые "читают" комменты кода и потом создают что-то типа HTML (т.е какой-то документ).

Может кто подскажет как их найти? (для кода C++, C#, жедательно Shareware).

Мне кажется, вам надо глядеть в эту сторону:
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx
http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx

Я встречался с таким подходом, но сам, честно говоря, не пробовал. Уж больно скупы возможности форматирования на первый взгляд... Хотя, если изучите вопрос, буду рад услышать о вашем опыте :-)
 
Попробуйте doxygen, он для с++ генерит доки по коду. Про с# - не уверена.
А тут пишу Я - http://fortechwriters.com/
 
те комментарии, которые пишут некоторые программисты могут создать просто шедевральную книгу)
Работаю по-старинке...
 
Цитата
те комментарии, которые пишут некоторые программисты могут создать просто шедевральную книгу)
Это точно! Это просто счастье какое-то, когда ты знаешь где лежит сорс, чтобы подправить коммменты.
А тут пишу Я - http://fortechwriters.com/
Страницы: 1
Читают тему

Рейтинг@Mail.ru