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

Question

Когда я использовал 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#?

спасибо.

Answer 1

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

Я так не считаю. На самом деле XML documentation (format) не является особенностью sandcastle, а компилятора C#. Sandcastle (и другие инструменты, такие как NDoc) «просто» основываются на нем.

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

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

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