Подтвердить что ты не робот

Что делает 3 '/в строке на С#?

Я кодировался на лала, когда вдруг впечатал 3'd '/' в комментарии. Первоначально комментарий идет зеленый с 2 '/ :

Subject1

Но с третьим тире он идет серый '///' :

Subject2

Имеет ли это какое-то конкретное значение? Или это просто изменило цвет?

4b9b3361

Ответ 1

Он обозначает XmlComment, о котором можно прочитать в MSDN. Например,

/// <summary>
/// Method summary  - a method that does something
/// </summary>
/// <param name="i">Description of param</param>
/// <param name="s">Description of param</param>
/// <returns>An object of some sort or other</returns>
public object AMethod(int i, string s)
{
}

Изменить: как показано ниже, он также обеспечивает IntelliSense, как показано на рисунке ниже.

Enter image description here

Ответ 2

Комментарии с тремя слэшами предназначены для конструктора документации. Вы можете создавать документацию по вашим API прямо из источника. Вы можете документировать, что делает ваш API, какие параметры он принимает, какие исключения он выбрасывает и т.д. Прямо в вашем источнике. Microsoft предоставляет инструменты для проверки того, что ваша документация синхронизирована с фактическим API. Например, если вы добавляете, удаляете или переименовываете параметр, но забудьте зарегистрировать изменение, вы получите предупреждение.

Вот как вы создаете документацию из этих тегов с помощью Visual Studio: ссылка.

Ответ 3

/// для комментария XML. он предоставляет комментарий в формате XML. Вы также можете создать XML-документ из этого, используя параметры /doc: при компиляции из этого, например

csc /doc:filedoc.xml program.cs