В чем разница между // и /// в Visual Studio?

Question

Stylecop говорит мне использовать /// вместо //, когда я комментирую. Какова семантическая разница между этими двумя и когда я должен использовать какой?

Answer 1

// обозначает ваши личные комментарии, где /// обозначает комментарии, которые могут содержать специальные данные, например, разметка для интерпретации Visual Studio - как:

/// <summary>
/// This class does something.
/// </summary>
class Bob {
    ...
}

Это сообщит Visual Studio краткую информацию о классе Bob и отобразится в окне завершения кода.

Answer 2

Сам нашел, проходя дальнейшие правила Stylecop:

Использовать // при комментировании

Используйте /// при документировании для заголовков XML-документации

Answer 3

Нет семантической разницы, это просто стиль кодирования или комментирования. .NET, случается, выбирает это для комментариев. Обычно полезно следовать этим правилам для инструментов автоматического документирования кода, таких как sandcastle .

Например, doxygen имеет совершенно другой стиль комментирования для кода C ++. Так что это в основном для последовательности и стандартов

Answer 4

Тройной слеш дает вам автоматически сгенерированный шаблон с параметрами и другими автоматическими функциями для вас

/// <summary>
///  Here is your comment
/// </summary>
/// <param name="sender">parameter generated automatically</param>
/// <param name="e">as above</param>
void BindableCollection_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Этот подход означает, что такой инструмент, как NDoc, может затем автоматически перенаправить ваш источник для создания файлов документации. Двойная косая черта просто не режет ....