2015-10-28 4 views
0

Я документирую проект C#, который построен из одного пространства имен, который содержит 8 интерфейсов, классов и перечислений.Документация на C# - можно добавить родительские узлы в пространство имен?

Я использую последнюю версию sandcastle (июль 2015 г.). Поскольку все интерфейсы, класс и перечисления находятся под одним и тем же пространством имен, с результатом sandcastle я получаю все под одним и тем же родительским узлом содержимого API, чего я не хочу. Вместо этого я хотел бы иметь все интерфейсы под одним родителем, все классы под другим родительским узлом и все перечисления под другим. Кроме того (если возможно), я хотел бы, чтобы для каждого родительского узла API был концептуальным родственным узлом, чтобы описать концепцию.

Возможно ли это? Если нет, можете ли вы предложить другие решения? Извещение Я не могу добавить пространства имен.

С песочным замком - можно ли использовать несколько макетов контента, по одному для каждого интерфейса? (не уверен, что можно использовать более одного макета контента для пространства имен).

Благодаря

ответ

1

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

Sandcastle не поддерживает обработку документации API для нескольких узлов. Поэтому обходной путь, который я нашел, заключается в том, чтобы использовать диспетчер Workshop для HTML, чтобы по мере необходимости переставлять HTML-файлы. Просто создайте проект в менеджере Workshop HTML и настройте его на использование HTML-файлов, созданных Sandcastle. Обратите внимание, что имена файлов HTML в Sandcastle являются только номерами, поэтому необходимо как-то переименовать их в соответствии с html-контентом.

HTML Workshop Manager имеет интерфейс командной строки, поэтому весь процесс создания CHM из htmls Sandcastle может быть автоматизирован. Для этого вам нужно заранее создать проект в менеджере Workshop HTML и написать код для обновления своей таблицы содержимого (файл .hhc) и индексного файла (.hhk), чтобы они использовали HTML-файлы Sandcastle. Я рекомендую использовать пакет гибкости HTML для этого, поскольку файлы .hhc и .hhk являются htmls.

Комментарии будут рассмотрены.

 Смежные вопросы

  • Нет связанных вопросов^_^