.Net Library style Комментарии

Question

.NET Framework предлагает "///" для документации в коде. Однако, когда я вижу библиотеку.NET, я вижу, что они используют обычный комментарий, начинающийся с "//". Кроме того, я вижу, что благодаря этому API выглядят чистыми. Смотрите скриншот ниже:

Обратите внимание, что в свернутой рамке отображаются только эллипсы ("..."), которые помещаются перед объявлением метода. Но когда я пытаюсь следовать тому же самому, я не получаю желаемого результата. Смотрите скриншот ниже:

Обратите внимание, что я получаю символы "//" вместе с эллипсами ("..."). Кроме того, я не могу разместить поле / метод и комментарий в одной строке.

Как мне достичь того же результата? Есть ли какая-то хитрость, которую я здесь пропускаю?

Answer 1

Тем не менее, когда я вижу библиотеку.NET

Вы не смотрите на фактический исходный код. Это просто представление метаданных, сгенерированных для вас Visual Studio. Похоже, что какая-то документация извлекается откуда-то (это не происходит на моем устройстве, как я только что попробовал, но это другой вопрос). Вы можете сказать, что это не настоящий исходный код, потому что есть конструкторы, объявленные без тела.

Если вы посмотрите на подлинный исходный код, например ReferenceSource для TcpClient, вы увидите комментарии с тройным слешем. Интересно, что код.NET Core также не имеет комментариев XML, но я подозреваю, что это потому, что они определены в другом месте, как часть.NET Standard. (Там есть файл XML вdotnet-api-docsрепо, но не сразу понятно из чего это получается...)

Что касается вашего собственного кода, я настоятельно рекомендую использовать /// синтаксис. /** ... */ должно работать, но я не помню, чтобы когда-либо видел это в коде C#. // не является допустимым способом написания комментария XML в C#.