Создание документации RESTful API из службы WCF

Question

Я недавно начал проект по созданию RESTful API в WCF, и мне нужно будет представить документацию вместе с самим API. Я надеялся использовать комментарии XML-кода в моих документах для этой документации.

Но я хочу вывести только контракты, предоставляемые службой: конечные точки и структуры объектов JSON / XML. Поскольку я пытаюсь создать внешнюю документацию, меня интересует какая-либо внутренняя часть моей библиотеки или как она связана с .Net Framework (или даже с тем, что это .Net, в этом отношении).

Какие у меня есть варианты инструментов для создания этих документов? Я слышал, что Sandcastle или Doxygen - хорошие инструменты для создания документов из комментариев к коду XML, но могу ли я отфильтровать классы и методы, которые я не хочу показывать?

Answer 1

Я понимаю, что этот вопрос задавался до .NET 4.0, но начиная с .NET 4.0 вы можете создать «страницу справки», как описано в Страница справки веб-службы WCF * .

WCF 4.0 Пример

[System.ComponentModel.Description("Triggers Method Name Behavior.")]
public void MethodName() {}

Answer 2

Конечно, вы можете фильтровать нежелательные APIMembers с помощью Sandcastle. Этот блогер описывает как. Если вы новичок в Sandcastle, вы можете попробовать Sandcastle Help File Builder , который в основном представляет собой Sandcastle Внешний интерфейс.

Answer 3

Вы можете настроить doxygen для генерации документа из указанных файлов. Почему бы не взглянуть на документы о кислороде?