Как я должен документировать мое приложение [закрыто
-
01-10-2019 - |
Вопрос
Мы разработали приложение в C # .NET и стремиться сделать его развертываемым в нашей интрасети. Мы хотели бы иметь солидную документацию, чтобы идти вместе с ним, но не уверены в лучшей платформе, чтобы документировать это. Любые инструменты, доступные для облегчения этого процесса?
Я узнал о Doxygen, HTMLHELP или DR объяснить, но я все еще не убежден, что использовать.
Решение
Если хотите генерировать что-то похожее на MSDN, вы можете попробовать Sandcastle (созданный Microsoft).
Вы можете либо использовать Помогите построить файл для пользователей или Компилятор документации для управляемых классов библиотек Если ваше приложение является общей библиотекой для других разработчиков (хотя из вашего описания звучит так, как вы захотите использовать файл справки).
Другие советы
Если вы хотите MSDN-подобное документацию кода, вы также можете попробовать Vsdocman.