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

Question

Я портирую библиотеку приложений с Java на C#. В документации Java есть места, которые ссылаются на конкретную ссылку на код, используя пользовательский текст. Например:

Suffix --> {@link DataOutput#writeString String}

Я попытался использовать аналогичный подход в комментариях к документации XML...

Suffix --&gt; <see cref="DataOutput.WriteString(string)">String</see>

... но вся эта ссылка просто исчезает как из Intellisense, так и из сгенерированной документации, когда я пытаюсь это сделать таким образом. Вопрос в том, как создать аналогичные ссылки на код с пользовательским текстом, используя комментарии к документации.NET XML в C#? Если нет способа сделать это, каков рекомендуемый обходной путь?

Если это имеет значение, мы экспериментируем с использованием генератора кода DocFx.

Answer 1

Вы можете использовать синтаксис перекрестных ссылок DocFX: [String](xref:DataOutput.WriteString(System.String)),

Смотрите: http://dotnet.github.io/docfx/tutorial/links_and_cross_references.html