SandCastle: Генерация ссылок для имени класса C#

Когда я использовал doxygen для своих проектов на C++, я просто написал:

/**
* I can refer to SomeClass or even SomeClass::someMethod() without special markup.
*/

Затем doxygen генерирует ссылки из строк «SomeClass» и «SomeClass::someMethod()» на соответствующую документацию.

Сейчас я работаю с C# и хочу использовать SandCastle для генерации документации из кода C#. Я понял, что ссылки должны быть построены с тегом xml:

/// <see cref="SomeClass"/> and <see cref="SomeClass.someMethod()"/>

Я думаю, что это очень громоздко и нечитабельно.

Есть ли способ генерировать ссылки для классов и методов без специальной разметки? Как вы создаете документацию для проектов C#?

Спасибо.


.net c# documentation-generation sandcastle
person Aleksey    schedule 22.06.2012    source источник

Ответы (1)


arrow_upward
3
arrow_downward

Есть ли способ генерировать ссылки для классов и методов без специальной разметки?

Я так не думаю. На самом деле документация XML (формат) не является функцией замка из песка, но компилятора С#. Sandcastle (и другие инструменты, такие как NDoc) «просто» строятся на нем.

Как вы создаете документацию для проектов C#?

Мы используем Sandcastle и Построитель файлов справки Sandcastle (SHFB). Также мы используем GhostDoc и ReSharper, которые помогают писать и (на лету) проверка XML-комментариев, например, если тип, метод или что-то еще, на что вы ссылаетесь, действительно существует.

Я думаю, вы также можете использовать Doxygen и, следовательно, комментарии в стиле Doxygen с вашим кодом C #, но лично я никогда не пробовал. Вам необходимо проверить веб-сайт Doxygen. Но вы упустите функции, предоставляемые другими инструментами на основе XML-документации (например, быстрая документация ReSharper).) или, что наиболее важно, тексты справки/описания для Intellisense.

person Christian.K    schedule 22.06.2012