none
Документирование кода с помощью XML-комментариев RRS feed

  • Вопрос

  • Здравствуйте! Создал xml файл документации со следующим содержимым

    <?xml version="1.0" encoding="utf-8" ?>
    <docs>
      <members name="fbaseform">
        <FBaseForm>
          <summary>
            Базовый <c>FBaseForm</c> класс.
            Содержащий основные методы базовой функциональности формы. 
          </summary>
        </FBaseForm>
        <BindGrid>
          <summary>
            Выполняет привязку GridControl к источнику данных, и опционально к элементам управления на форме.
          </summary>
          <param name="grid">Обьект GridControl к которому необходимо выполнить привязку.</param>
          <param name="package">Название основной таблицы привязки/пакета без приставки "pack_".</param>
          <param name="pars">Массив параметров передаваемых подпрограмме выборки, перечисленных через запятую: parameterName, parameterValue.</param>
          <param name="keymap">Массив с именами полей таблицы и значениями, которые будут установлены по умолчанию при добавлении новой строки, перечисленных через запятую: FieldName, Value.</param>
          <param name="handler">Not described!</param>
          <param name="cache">Если true - таблица возвращенная запросом будет добавлена в коллекцию Tables. Поумолчанию true.</param>
          <param name="autobind">Если true - выполнить привязку к элементам управления формы. Поумолчанию false.</param>
          <returns>Таблица возвращаемая запросом.</returns>
          <example>
            <code>
              public override void Find()
              {
                BindGrid(grReservedRange, "RESERVEDRANGE", new object[] {"p_rr_id", Id}, new object[] {"rr_id", Id}).KeySequence = "s_reservedrange";
              }
            </code>
          </example>
        </BindGrid>
      </members>
    </docs>

    В коде внес соответствующую инструкцию include перед именем метода, но IntelliSens не отображает информацию о методе, как в случае использования тега summary 

            /// <include file='docs.xml' path='docs/members[@name="fbaseform"]/BindGrid/*'/>
            public ADataTable BindGrid(GridControl grid, string package, object[] pars = null, object[] keymap = null, DataRowChangeEventHandler handler = null, bool cache = true, bool autobind = false)

    Подскажите в чем может быть проблема?


    Shilin Andrej

    6 октября 2017 г. 9:14

Ответы