Как я должен документировать свое приложение

Question

Мы разработали приложение в C# .net и постараемся сделать его доступным для развертывания в нашей интрасети. Мы хотели бы иметь прочную документацию, чтобы согласиться с ней, но не уверены в лучшей платформе для документирования этого. Какие инструменты доступны для облегчения этого процесса?

Я узнал о Doxygen, Htmlhelp или Dr Explain, но я все еще не уверен, что использовать.

Answer 1

Если вы хотите сгенерировать что-то похожее на MSDN, вы можете попробовать Sandcastle (который создается Microsoft).

Вы можете использовать Help File Builder для пользователей или Documentation Compiler for Managed Class Libraries, если ваше приложение является общей библиотекой для других разработчиков (хотя из вашего описания это похоже на то, что вы захотите использовать Builder).

Answer 2

Если вы хотите документацию на код MSDN, вы также можете попробовать VSdocman.