Альтернатива комментариям к документации XML в C # - PullRequest
Новая
       34

Альтернатива комментариям к документации XML в C #

0 голосов
/ 02 февраля 2019

Когда вы спрашиваете об условных комментариях к документации в коде C #, ответ всегда приводит к использованию XML-комментариев.Microsoft рекомендует такой подход и самим.https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments

/// <summary>
/// This is an XML comment.
/// </summary>
void Foo();

Однако при проверке кода Microsoft, такого как ASP.NET Core, комментарии вместо этого выглядят следующим образом. 

//
// Summary:
//     A builder for Microsoft.AspNetCore.Hosting.IWebHost.
public interface IWebHostBuilder

Работает ли включенный инструмент создания документов с этимсоглашение, или есть инструмент создания документации, который использует это соглашение вместо XML?Почему Microsoft использует это соглашение в своем коде вместо комментариев XML, которые они рекомендуют сами?

...