Sandcastle - по-прежнему правильная вещь для использования? Или есть альтернативы?

Мне просто интересно - последняя версия Sandcastle - с мая 2008 года, и она по-прежнему указана как предварительная версия программного обеспечения /CTP, и он даже не лицензируется, поскольку в EULA указано:

2.TERM. Срок действия этого соглашения до 1 сентября 2007 года или коммерческий выпуск программного обеспечения, в зависимости от того, что наступит раньше.

Так как Sandcastle довольно "тяжелый", мне просто интересно, правильно ли это использовать или есть альтернативы для создания документации XmlDoc? (Альтернативы = что-то, что я могу запустить из моей сборки, чтобы создать как минимум HTML, желательно PDF).

ОТВЕТЫ

Ответ 1

Никто не упомянул Docu, недавний проект, начатый Джеймсом Грегори, dev на FluentNHibernate.

Это очень простой и простой в использовании инструмент, который генерирует html-документацию la rdoc. Вы можете легко изменять шаблоны, так как Docu использует Spark в качестве механизма просмотра.

Вот документация FluentNHibernate, созданная с помощью Docu.

Ответ 2

Microsoft Sandcastle определенно остается верным путем. Основная альтернатива (которая предлагает что-то близкое к набору функций Sandcastle) NDoc, но последняя версия этого файла намного старше, в январе 2005 года!

Несмотря на то, что он до сих пор технически находится в стадии досрочного освобождения, он на самом деле является довольно стабильным инструментом. Небольшое количество ошибок было исправлено патчами, доступными на CodePlex в рамках проекта Sandcastle Styles. Для этого также есть превосходный графический интерфейс, а именно Sandbule Help File Builder.

Я не уверен в будущем развитии Sandcastle. Я полагаю, что в какой-то момент Microsoft продолжит работу/расширение, хотя, похоже, нет никаких новостей о том, когда. Это, безусловно, единственный достойный инструмент для создания надлежащей документации для библиотеки .NET или приложения, на данный момент. Конечно, вы можете часто избегать использования более "легких" инструментов для небольших проектов/файлов справки. Основные альтернативы, которые я заметил, являются коммерческими и уступают Sandcastle.

Генерация документации вручную/с использованием пользовательской автоматизации, вероятно, возможна в некоторых случаях, но только для небольших проектов (которые вряд ли будут расширяться.)

Ответ 3

Насколько мне известно, Sandcastle по-прежнему остается верным выбором. Я использовал его много раз в недавнем прошлом и не имею проблем. Вы можете проверить эту страницу в MSDN и прокрутить вниз до раздела "Документация" для других хороших вариантов:

Инструменты программирования на С#

Ответ 4

Чтобы эффективно использовать Sandcastle, вам нужно, как указывал ранее Нолдорин, также использовать стили Sandcastle и конструктор файлов справки Sandcastle (SHFB). Все они выпустили новый релиз в середине 2010 года, поэтому, безусловно, текущие инструменты.

Однако даже с чистым и простым графическим интерфейсом, предоставляемым SHFB, существует целый ряд проблем, которые вам могут потребоваться или вы хотите рассмотреть, чтобы создать удобный набор профессиональных документов. Моя статья ( " Taming Sandcastle: Руководство для программиста .NET для документации вашего кода), документируя мой опыт с различными потенциальными ловушками, опубликованными на Simple-Talk.com в сентябре 2010 года, может сохранить вас некоторое время, усилие и агонию: -).

Еще один полезный ресурс: В октябре 2010 года я просмотрел статью с помощью одностраничной настенной диаграммы, которая обобщает лексику комментариев документации XML для SHFB.

Ответ 5

Sandcastle по-прежнему остается правильным выбором. Я использовал его для многих проектов в прошлом.

В любом случае, взгляните на них:

  • NDoc
  • GhostDoc - бесплатное расширение Visual Studio

Ответ 6

DocProject стоит посмотреть. Это отнимает много боли от работы с песочным замком.

Ответ 7

Я поставил короткий список некоторых инструментов документации в этом вопросе SO: anyone-using-ndoc-or-a-similar-tool

Я думаю, что SandCastle - лучший инструмент для раскрытия информации в настоящее время (для документирования .NET-проектов), но есть несколько коммерческих инструментов, и они могут предложить лучшую производительность и больше возможностей, поэтому, если у вас есть бюджет для одного из них, стоит по крайней мере, оценивая, какую ценность он может принести вам.