|
|
Документирование кода и генерация документации в виде HTML или CHM
Останнє повідомлення 28-09-2007, 4:05 від Mike Chaliy. 11 відповіді.
-
-
 26-09-2007, 6:47 |
-
Mike Chaliy
-
-
-
Зареєстрований 16-11-2006
-
Ukraine, Kharkiv
-
Повідомлення 756
-
Бали 13,837
-
|
Re: Документирование кода и генерация документации в виде HTML или CHM
 Chiz_:Пишу ПО в Microsoft Visual Studio 2005 Express Edition под 2й framework. Все нормально пишется. Документацию студия генерирует только в XML, а мне необходимо в html или chm. Я попробовал doxygen, VSdocman, NDoc и Sandcastle, но либо я тупой, либо оно не работает. Кто сталкивался с генерацией документации, подскажите. Попробовал конвертировать xml в ... во что угодно, хотя бы во что-то. Попробовал Advanced XML Converter. Пишет "процес идьот". Процес заканчивается. Файла нет. Дал побольше xml - прога вылетела.
Генерував за допомогою NDoc та Sandcastle, все чудово працює. З NDoc покищо набагато легше, але на час коли я це робив багато чого з фітч другого фрамеворка реалізовано не було.
Про Advanced XML Converter, навіть не чув. А ось про NDoc та Sandcastle швидше за все зможу допомогти. Головне питайте щось більш конкретніше ;).
MCPD(Web,Windows,Enterprise), MCTS (WPF, WCF)
|
|
-
| 26-09-2007, 7:44 |
-
| 26-09-2007, 8:06 |
-
Mike Chaliy
-
-
-
Зареєстрований 16-11-2006
-
Ukraine, Kharkiv
-
Повідомлення 756
-
Бали 13,837
-
|
Chiz_: Может стоит сначала задокументировать полностью хотя бы один класс? : о))
Це не завадить ;)..
MCPD(Web,Windows,Enterprise), MCTS (WPF, WCF)
|
|
-
| 27-09-2007, 4:11 |
-
Chiz_
-
-
-
Зареєстрований 26-09-2007
-
Kharkiv
-
Повідомлення 16
-
Бали 640
-
|
отключение дегенератора комментов в студии
ТАкой вопрос - а можно ли каким-то макаром незнаю каму задать какой-нибуть параметр, чтобы генерировался xml только с теми комментами, которые написал я, а не сгенерировал дизайнер в студии?
|
|
-
| 27-09-2007, 4:33 |
-
Mike Chaliy
-
-
-
Зареєстрований 16-11-2006
-
Ukraine, Kharkiv
-
Повідомлення 756
-
Бали 13,837
-
|
Re: отключение дегенератора комментов в студии
Chiz_: ТАкой вопрос - а можно ли каким-то макаром незнаю каму задать какой-нибуть параметр, чтобы генерировался xml только с теми комментами, которые написал я, а не сгенерировал дизайнер в студии?
Як він повинен відрізняти твої коменти від своїх? За стилістикою?
MCPD(Web,Windows,Enterprise), MCTS (WPF, WCF)
|
|
-
| 27-09-2007, 6:41 |
-
Chiz_
-
-
-
Зареєстрований 26-09-2007
-
Kharkiv
-
Повідомлення 16
-
Бали 640
-
|
Re: отключение дегенератора комментов в студии
Не знаю : о))
В том-то и дело, что я не знаю. ПО этому и спрашиваю.
МОжет можно как-то вырубить автоматическое документирование кода студией? А то он документирует всякую чушь, которая никому не интересно : о))
|
|
-
| 27-09-2007, 7:00 |
-
Mike Chaliy
-
-
-
Зареєстрований 16-11-2006
-
Ukraine, Kharkiv
-
Повідомлення 756
-
Бали 13,837
-
|
Re: отключение дегенератора комментов в студии
Chiz_: Не знаю : о)) В том-то и дело, что я не знаю. ПО этому и спрашиваю. МОжет можно как-то вырубить автоматическое документирование кода студией? А то он документирует всякую чушь, которая никому не интересно : о))
В 2008 частково пофіксили, принаймні Summary descrip... вона не пише. Для попередніх потрібно виправити темплейти. Темплейти знаходяться в c:\Program Files\Microsoft Visual Studio 8\Common7\IDE\ItemTemplates\CSharp\1033\.
MCPD(Web,Windows,Enterprise), MCTS (WPF, WCF)
|
|
-
| 27-09-2007, 7:51 |
-
| 27-09-2007, 10:39 |
-
demon_xxi
-
-
-
Зареєстрований 11-11-2006
-
Харьков
-
Повідомлення 244
-
Бали 4,220
-
|
Chiz_: Не генерируется документация для некоторых классов.
Есть классы, которые наследуют мега-класс Form - для таких классов у меня генитально генерится документация.
А есть классы, которые я сам писал, без наследования каких-либо классов. Эти классы я тоже комментировал, но в html нету упоминания про эти классы. В xml есть, а в html, который я генерирую с помощью NDOc - нет.
А они случайно не private или internal ? Может только для public генеритьясс документация 
Лучше побыть дураком 5 минут, чем остаться им на всю жизнь ...
|
|
-
| 27-09-2007, 23:40 |
-
Chiz_
-
-
-
Зареєстрований 26-09-2007
-
Kharkiv
-
Повідомлення 16
-
Бали 640
-
|
demon_xxi: А они случайно не private или internal ? Может только для public генеритьясс документация
Они не случайно были вооообще без модификатора. Я так понимаю, что это private по умолчанию.
Все генерится. Всем бальшущее спасибо!!!
|
|
-
| 28-09-2007, 4:05 |
-
Mike Chaliy
-
-
-
Зареєстрований 16-11-2006
-
Ukraine, Kharkiv
-
Повідомлення 756
-
Бали 13,837
-
|
Chiz_:
Я так понимаю, что это private по умолчанию.
По замовчуванню вони internal.
MCPD(Web,Windows,Enterprise), MCTS (WPF, WCF)
|
|
|
|
|