Блог

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

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

Я надеялся, что в моей концептуальной документации будут ссылки на некоторые типы в моих источниках документации. Есть ли способ поместить что-то простое, например «> Type, для ссылки на документацию, которая также есть в коде?

РЕДАКТИРОВАТЬ: это было серьезной проблемой для меня, поскольку я новичок в этом.

Лучший способ создать ссылку на элемент кода — захватить его из окна Entities . Чтобы открыть окно сущностей, перейдите в Окно> Ссылки на сущности. Отсюда вы можете найти подходящий тип / метод / свойство и перетащить его в код из результатов.

Справочное руководство по MAML включено в загрузку стилей песочных замков: http://sandcastlestyles.codeplex.com / и был ОЧЕНЬ полезен в изучении того, как форматировать вещи.

Вы можете создать ссылку из концептуальной документации на справочную документацию, используя codeEntityReference . Подробности, пожалуйста, см.: http://davesexton.com/blog/blogs/blog/archive/2008/05/24/maml-migration-the-next-step-in-the-evolution-of-help-authoring.aspx