Советы по использованию C # в Visual Studio

Question

Каков источник этих советов по использованию методов в Visual Studio? Я не могу понять, откуда они берутся?!

Answer 1

Я прокомментировал ранее, но просто для более подробной информации, эти советы по использованию происходят от /// <summary> тегов, добавляемых к методам / классам / и т. Д. В файлах кода.

Это довольно стандартно для .net и API-интерфейсов, чтобы добавлять итоговые теги к классам и функциям, чтобы дать вам некоторое представление о том, для чего он должен использоваться (хотя часто с разными результатами).

Если вы хотите определить свои собственные советы по использованию, все, что вам нужно сделать, это добавить следующее, что вы хотите, чтобы подсказка (класс, структура, функция, член и т. Д.):

/// <summary>
/// fill in your hint here
/// </summary>
public class SomeClass 
{
    /// <summary>
    /// Prints text
    /// </summary>
    /// <param name="text"> String that is printed </param> // param's aren't required though
    public void SomeFunc(string text) 
    {
        Console.WriteLine(text);
    }
}

Answer 2

Это происходит из встроенных комментариев, прикрепленных к этим методам в исходном коде, из которого они были скомпилированы.

Если вы хотите добавить такую ​​же информацию в свой собственный код, то вы можете сделать это. Например, вы можете написать

/// <summary>  
///  This class performs an important function.  
/// </summary>  
public class MyClass {

   /// <summary>
   /// This method accepts an input string and returns a boolean value depending on what was input
  /// </summary>
  /// <param name="input">An arbitrary string value to be evaluated</param>
  /// <returns>A boolean value. If the input value equals "hello" then it will return true. Otherwise, false is returned </returns>
  public bool string MyMethod(string input) {
    if (input == "hello") return true;
    return false;
  }
}

В Visual Studio просто начните вводить /// в строке над объявлением вашего метода / класса / свойства, и VS обычно автоматически заполняет объявление для вас, и вы можете просто заполнить текст.

Как только вы попытаетесь использовать этот метод из другого раздела вашего кода, ваши комментарии будут отображаться в поле intellisense при вводе.

Подробнее см. https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/.