XML-комментарии к частичным классам / методам

Есть ли стандартный способ, которым инструменты, используемые для создания документов API, обрабатывают комментарии стиля XML к частичным классам? В принципе, как следует прокомментировать частичный класс / метод, чтобы полученные справочные документы не были искажены? Этот вопрос может варьироваться в зависимости от используемого инструмента, и в этом случае я полагаю, что двумя наиболее важными инструментами являются:

  • Visual Studio ' s встроенный метод создания XML-документации
  • Microsoft's Sandcastle

Я не хочу, чтобы моя XML-документация выглядела напуганной, это все

/// <summary>Some Foo class</summary>
public partial class Foo { ... }

/// <summary>Some Foo class that implements some interface.</summary>
public partial class Foo : ISomeInterface { ... }
20
задан Keith 16 December 2015 в 15:28
поделиться