Документ ASMX веб-сервис

Question

Я разрабатываю веб-сервис для публикации для разных пользователей.

Чтобы сгладить их работу, я хочу задокументировать все мои веб-методы и их объекты ввода / вывода, как на изображении ниже (это пример, который я видел в сети).

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

Я пытался использовать WCFExtras, но не подходит для моего проекта, потому что это не служба WCF: /

Я спрашиваю: есть ли какой-нибудь инструмент для такой работы? Кто-нибудь знает какие-либо свойства или рамки .NET для использования?

Answer 1

Я доволен комбинацией Sandcastle и стандартной C # XML-документации .

По сути, вы комментируете методы как обычно (type /// прямо перед именем типа или метода для создания каркаса комментария).Затем вы включаете включить вывод документации XML для проекта.Наконец, вы используете инструмент (например, Sandcastle), чтобы использовать сгенерированный файл XML для создания файла справки / веб-сайта.

В случае Sandcastle он генерирует CHM.Мне лично нравится просматривать API в виде файла CHM.Есть и другие инструменты, чтобы сделать это веб-сайтом.