руководства для разработчиков

Question

Моя команда и я находимся на финальной стадии нашего проекта разработки программного обеспечения.Мы используем Visual Studio для компиляции нашего проекта и написания кода на C #.Нам нужно построить руководства пользователя.Есть ли способ сгенерировать руководства пользователя из комментариев приложения и кода?

Answer 1

Если вы правильно прокомментировали свой код, есть ряд сторонних инструментов, которые вы можете использовать для создания документации.

Следующий список не является исчерпывающим:

• SandCastle
• NDoc
• Doc-O-Matic
• VSdocman
• Doxygen
• ...

Я просто надеюсь, что ваши конечные пользователи - разработчики, а вы пишете какой-то API. Этот вид инструмента генерации документации обычно подходит только для внутреннего использования или внешних разработчиков, для которых вы создали API, который они могут использовать.

Answer 2

Если вы используете комментарии к документации XML ... вы можете использовать опцию /doc compile.

Комментарии к документации XML

Когда вы компилируете с параметром / doc, компилятор будет искать все теги XML в исходном коде и создать файл документации XML. Создать итоговую документацию на основе сгенерированного компилятором файл, вы можете создать собственный инструмент или использовать такой инструмент, как DocFX или Sandcastle.

Answer 3

Если вашей целевой аудиторией были другие разработчики, вы могли бы сделать что-то вроде того, что упомянуто в этом SO сообщении , но если это конечные пользователи, которые не являются разработчиками, то вряд ли комментарии в вашем коде все это будет полезно для них, и если они ... то, вероятно, они не так полезны для разработчика.