Как создать сайт из комментариев XML документации?
Я хотел бы создать веб-сайт документации из комментариев документации C# XML.
Пример из сообщества Python. Эта документация Scipy создается из этого кода Python с использованием инструмента под названием Sphinx.
Возможно ли что-нибудь подобное для проекта на C#?
Пример комментариев к документации XML в проекте.NET (не моем) https://github.com/haf/NodaTime/blob/master/src/NodaTime/Period.cs#L26
/// <summary>
/// Represents a period of time expressed in human chronological terms: hours, days,
/// weeks, months and so on. All implementations in Noda Time are immutable, and return fields
/// in descending size order: hours before minutes, for example.
/// </summary>
public sealed class Period : IEnumerable<DurationFieldValue>, IEquatable<Period>
Изменить: полный совет, который я мог найти в других вопросах, был "использовать Sandcastle ". Насколько я могу судить из его (по иронии судьбы) документации, он может создавать только файлы справки Windows (.chm). Это верно?
3 ответа
Изменить: полный совет, который я мог найти в других вопросах, был "использовать Sandcastle". Насколько я могу судить из его (по иронии судьбы) документации, он может создавать только файлы справки Windows (.chm). Это верно?
Нет, это не правильно. Sandcastle может построить широкий спектр продукции.
Тем не менее, в эти дни вам действительно нужен Sandcastle Help-File Builder (SHFB), который делает все намного лучше. Все еще не совсем безболезненно, но довольно хорошо. Документация для SHFB, как правило, тоже довольно разумная.
Забавно, что вы должны привести пример Noda Time - именно SHFB мы используем для создания нашей онлайн-справки по API.
Вы также можете попробовать sharpDox. Еще один бесплатный генератор документации с открытым исходным кодом. Вы можете создавать html и chm выходные документы и документы Word.
Вот пример для вывода html.
PS: я создатель этого инструмента.
Для решения в один клик вы также можете попробовать наш VSdocman.