Сандкасл Авторинг для концептуальных тем - PullRequest
1 голос
/ 05 октября 2011

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

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

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

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

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

Справочное руководство по MAML включено в загружаемую версию Sandcastle Styles: http://sandcastlestyles.codeplex.com/ и очень полезно при обучении форматированию объектов.

1 Ответ

2 голосов
/ 13 декабря 2011

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

...