Сандкасл Авторинг для концептуальных тем
Я работаю над написанием некоторой концептуальной документации для нашей технической документации, которая производится в Сандкасле.
Там не так много хороших примеров / ссылок, но я начинаю понимать MAML. Если у кого-то есть отличные ресурсы для поиска / понимания этого, я был бы признателен.
Я надеялся, что моя концептуальная документация будет ссылаться на некоторые типы в моих источниках документации. Есть ли способ поставить что-то простое, например ">Type, чтобы ссылаться на документацию, которая также есть в коде?
РЕДАКТИРОВАТЬ: Это было серьезной проблемой для меня, так как я новичок в этом.
Лучший способ ссылки на элемент кода - получить его из окна сущностей. Чтобы открыть окно сущностей, откройте "Окно"> "Ссылки на сущности". Отсюда вы можете найти соответствующий тип / метод / свойство и перетащить его в код из результатов.
Справочное руководство по MAML включено в загрузку Sandcastle Styles: http://sandcastlestyles.codeplex.com/ и НЕМЕДЛЕННО помогло узнать, как форматировать объекты.
1 ответ
Вы можете создать ссылку из Концептуальной документации на Ссылочную документацию, используя codeEntityReference. Подробности см. По адресу: http://davesexton.com/blog/blogs/blog/archive/2008/05/24/maml-migration-the-next-step-in-the-evolution-of-help-authoring.aspx