Code Insight (IntelliSense)

Question

Я пытаюсь добавить описание к разработанным мной функциям - я хочу, чтобы это описание отображалось в понимании кода, когда другой разработчик использует мои модули или когда пользователь использует API / COM для соединения и использует наше программное обеспечение. На данный момент все, что они видят, это, например, Имя функции и тип возвращаемого значения, но они понятия не имеют, что именно делает функция.

в C # вы используете теги XML.

Answer 1

У Марко Канту есть отличное сообщение в блоге о том, как использовать ту же систему тегов XML, которую Visual Studio использует для настройки HelpInsight.

Answer 2

Я не уверен, что это то, что вам нужно, но:

    /// <summary>
    /// 
    /// </summary>
    /// <param name="par1"></param>
    /// <param name="bla"></param>
    /// <param name="foo"></param>
    /// <returns></returns>

Поместите это выше объявления функции (просто введите / символ три раза, и Visual Studio сделает волшебство) В итоге вы должны поставить описание