Sandcastle - все еще правильная вещь для использования? Или есть альтернативы? [закрыто
https://stackoverflow.com/questions/986741
-
13-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Мне просто интересно - последний релиз замок из песка с мая 2008 года, и он по-прежнему указан как программное обеспечение предварительного выпуска/CTP, и оно даже больше не лицензировано, как конкретно говорит Eula:
В любом случае, поскольку Sandcastle довольно «тяжелый», мне просто интересно, правильная ли это все это правильно, или есть альтернативы для создания документации XMLDOC? (Альтернативы = то, что я могу запустить из своей сборки, чтобы генерировать хотя бы HTML, предпочтительно PDF).
Решение
Никто не упомянул Docu, недавний проект, инициированный Джеймсом Грегори, Dev Lead on Fluentnibernate.
Это очень простой и простой в использовании инструмент, который генерирует HTML -документацию A LA rdoc. Анкет Вы можете легко изменить шаблоны, поскольку DOCU использует Искра как двигатель View.
Здесь Fluentnibernate документация построен с Docu.
Другие советы
Microsoft Sandcastle, безусловно, все еще верный путь. Основная альтернатива (которая предлагает что -то близкое к набору функций Sandcastle) - это Ndoc, но последний выпуск этого намного старше, будучи в январе 2005 года!
Хотя он все еще технически находится на (позднем) стадии перед выпуском, на самом деле это довольно стабильный инструмент. Небольшое количество ошибок было зафиксировано патчами, доступным на Codeplex как часть Стили -стили песка проект. Есть также превосходный графический интерфейс, а именно Сборщик справочных файлов Sandcastle.
Однако я не уверен насчет будущего развития Sandcastle. Я полагаю, что в какой -то момент Microsoft будет продолжать работу/расширение, хотя, похоже, нет никаких новостей о том, когда. Это, безусловно, единственный приличный инструмент для создания надлежащей документации для библиотеки или приложения .NET. Конечно, вы часто можете уйти, используя более «легкие» инструменты для небольших проектов/файлов справки. Основные альтернативы, которые я заметил, как коммерческие, так и уступающие Sandcastle.
Генерация документации вручную/использование пользовательской автоматизации, вероятно, возможно, в некоторых случаях возможно, но только для небольших проектов (которые вряд ли будут расширяться).
Насколько мне известно, Sandcastle все еще является действительным выбором. Я использовал его много раз в недавнем прошлом и не имею проблем. Вы можете проверить эту страницу на MSDN и прокрутить вниз в раздел «Документация» для других хороших вариантов:
Чтобы эффективно использовать Sandcastle, вам нужен, как указывал ранее Noldorin, чтобы также использовать стили Sandcastle и Справочник по справочнику Sandcastle (SHFB). У всех них был новый релиз в середине 2010 года, так что это определенно текущие инструменты.
Однако даже с чистым и простым графическим интерфейсом, предоставленным SHFB, существует довольно много проблем, которые вам могут понадобиться или вы хотите рассмотреть, чтобы создать аккуратный, профессиональный набор документации. Моя статья ("Укрощение Sandcastle: Руководство программиста .NET по документированию вашего кода") Документирование моего опыта с различными потенциальными ловушками, опубликованными на Simple-talk.com В сентябре 2010 года может сэкономить ты Некоторое время, усилия и агония :-).
Еще один полезный ресурс: В октябре 2010 года я следил за статьей с Одностраничная настенная диаграмма Это суммирует лексику для документации XML для SHFB.
Докпроект стоит взглянуть на. Это убирает большую боль от работы с Sandcastle.
Я поместил в этот вопрос короткий список некоторых инструментов документации, так что вопрос:Любой, кто использует NDOC-OR-A-A-SIMIREL-TOOL
Я думаю, что Sandcastle - лучший инструмент OpenSource в настоящее время (для документирования .NET Projects), но есть несколько коммерческих инструментов, и они могут предложить лучшую производительность и больше функций, поэтому, если у вас есть бюджет для одного из них, он стоит хотя бы оценить Какую ценность он может принести вам.
