Использование cref в описании класса с GhostDoc

Question

Я только начал использовать GhostDoc, так что я надеюсь, что это не глупый вопрос. Я хочу документировать Class1, ссылаясь на его метод Method1. Итак, я использую Cref в описании Class1 следующим образом.

/// <summary>
/// Use this class to do a lot of things.
/// </summary>
/// <remarks>
/// The most interesting method is <see cref="Method1"/>
/// </remarks>
public class Class1
{
    public void Method1(int a)
    { }
}

Создав файл справки с помощью GhostDoc Pro, я заметил, что cref не "связывался", то есть в документации под примечаниями говорится: "Самый интересный метод - [Method1]" (без ссылки на Method1). Как сделать так, чтобы ссылка появилась?

Answer 1

Вам нужно использовать полное имя метода, например

<see cref="M:MyNamespace.Class1.Method1(System.Int32)"/>

где MyNamespace - это ваше пространство имен.

В общем, найти правильный синтаксис довольно просто - включите документацию XML для проекта, скомпилируйте проект, посмотрите на сгенерированный файл XML Comments для синтаксиса.

Для методов, которые будут

M:<namespace>.<class>.<method name>(<parameters>):<return type>

Мы не против ответить на вопросы GhostDoc по SO, но вы, как правило, получите быструю помощь, если зададите свои вопросы на наших форумах сообщества - http://community.submain.com/

Спасибо!