Re: Примеры для документации
От: AndrewVK Россия http://blogs.rsdn.org/avk
Дата: 25.06.16 18:05
Оценка: 65 (4)
Здравствуйте, IT, Вы писали:

IT>Прикрутил автоматизацию генерации примеров.


Автоматизация, как оказалось, без надобности, все уже есть искаропки в sandcastle. Достаточно в коммент просто добавить тепг такого вида:
<code source="Main\tests\Mapping\Examples\MapTests.cs" lang="C#"/>

Путь к исходнику относительно корня репозитория. lang="C#" обязательно, если нужна подсветка синтаксиса на гитхабе.
И еще один момент — на гитхабе ширина дырки для кода — 91 символ. Соответственно нужно форматировать исходник чтобы скроллбар не вылазил.

UPD: Еще один хинт. Если нужно взять в качестве примера только часть исходника, то эту часть можно отделить регионом, а потом имя региона указать в теге code в атрибуте region.
... << RSDN@Home 1.0.0 alpha 5 rev. 0 on Windows 8 6.2.9200.0>>
AVK Blog
Отредактировано 25.06.2016 18:11 AndrewVK . Предыдущая версия .
Примеры для документации
От: IT Россия linq2db.com
Дата: 24.06.16 04:14
Оценка:
Прикрутил автоматизацию генерации примеров. Порядок действий:

— Создаём тест с примером в тестовом проекте. Можно для убедительности в каталоге Examples целевого пространства имён.
— Открываем шаблон Examples.tt в корне проекта и добавляем туда относительную ссылку на пример.
— Добавляем где нужно ссылку на код таким образом:

    /// <example>
    /// This example shows how to explicitly convert one value to another.
    /// <include file='..\Examples.xml' path='doc/Example[@name="Mapping\Examples\MapMemberTests.cs"]/*'/>
    /// </example>

Готово.

При изменении примера не забываем перезапускать шаблон.
Если нам не помогут, то мы тоже никого не пощадим.
Отредактировано 24.06.2016 4:14 IT . Предыдущая версия .
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.