Сандкасл или NDoc?Хороший MSDN-подобный генератор документов? - PullRequest
3 голосов
/ 18 декабря 2010

Я всегда беспокоил себя вопросом: «Javadoc, Doxygen и многое другое… неужели Microsoft не предоставляет своим разработчикам хороший генератор документов?».Это всегда звучало странно для меня ... Кроме того, потому что Msdn - очень хороший набор текста документации ... Я действительно предпочитаю это больше всего других генераторов и стилей документации.в этом вопросе и обнаружили существование NDoc и SandCastle.Ничего себе, сказал я себе, наконец-то понял ... Так казалось.Хорошо, они хорошие генераторы, но я подумал, что Microsoft спонсировал официальный документ немного больше, чем те два, о которых я упоминал ранее.

Итак, что я хочу?Просто зная, какой документ используется разработчиком Microsoft для документирования своего кода в стиле MSDN.Является ли NDoc или Sand Castle официальным MSDN-подобным генератором документов, одобрено моим Microsoft?Какой из них лучше?Если нет, какой документ следует использовать для документирования в стиле msdn?

Ответы [ 3 ]

2 голосов
/ 18 февраля 2011

Мы используем DocumentX (раньше использовал NDoc), и мне это очень нравится.Их система проверки лицензии немного трудна, но сама программа великолепна.

1 голос
/ 19 декабря 2010

Несмотря на то, что оригинальный проект NDoc был остановлен несколько лет назад, есть проект-преемник: NDoc3

1 голос
/ 19 декабря 2010

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

Кстати, вы можете получить плагин GhostDoc Visual Studio. Это значительно ускоряет создание комментариев к документам (даже может генерировать их полностью, если вы правильно называете свои методы, параметры и прочее).

...