Я хочу создать документацию на С#, моего приложения, похожее на Javadoc.
Я знаю, что на Java вы можете создать javadoc, но:
- Можно ли создать нечто похожее на javadoc, но на С#?
- И как я могу это сделать?
Спасибо за вашу помощь.
Я хочу создать документацию на С#, что-то похожее на javadoc
Ответ 1
Используйте обычный теги XMLDOC, чтобы документировать свой код, обычно этого достаточно, чтобы набрать /// в Visual Studio, чтобы получить теги по умолчанию. Затем используйте SandCastle для создания документации. Он может создавать обычные файлы справки, но также и webhelp.
SandCastle - не самый простой инструмент для работы. Обычно я использую построитель файлов Sandcastle, который является удобным графическим интерфейсом для sandcastle.
Ответ 2
Недавно я просмотрел это, когда у меня была средняя кодовая база для преобразования из Java в С#. Первоначально я хотел использовать sandcastle, так как это инструмент MS по умолчанию для этого, но я решил использовать doxygen по следующим причинам:
- Это очень легко загрузить и запустить. Я получил двоичные файлы (doxygen.exe) в zip с сайта doxygen, запустил "doxygen.exe -g Doxyfile.txt", чтобы сгенерировать конфигурационный файл по умолчанию, установить каталоги ввода и вывода, а затем запустить "doxygen.exe Doxyfile". txt 'для создания документов, которые были вполне пригодны для использования. Затем вы можете изменить его.
- Doxygen способен интерпретировать как существующие теги javadoc, так и читать теги dotnet xml, когда я начал конвертировать javadoc в xmldoc и добавьте новую документацию.
- Doxygen делает отличный вывод html, включая некоторый аккуратный поиск в JavaScript, а также поддерживает многие другие форматы, включая chm.
- Я полагал, что в любое время, когда я расскажу о том, как использовать doxygen, вы получите гораздо лучшую отдачу, чем использование sandcastle, поскольку я могу использовать doxygen для любого языка программирования.
Ответ 3
Посмотрите на GhostDoc (http://submain.com/products/ghostdoc.aspx)