Sandcastle не генерирует параметры или возврат

Question

У меня есть проект Visual Studio C # с комментариями к документации XML.Я получаю файл .xml с <summary>, <param>, <returns> и <example> членами.

Текст, который я поместил между тегами <summary>, отображается в файле справки, а такжеNamespace, Assembly, Example и See Also секции.Просто <param> и <returns> даже не имеют пустой секции, даже если она строится без ошибок.

Соответствующая часть сгенерированной .xml:

<member name="M:OPC_ClientLib.OPC_Client.getBit(System.String)">
    <summary> the summary text (is shown) </summary>
    <param name="variable">Variable name (not shown)</param>
    <returns>true or false, (not shown)</returns>
    <example>
        <code> bool bit = getBit("bitname")</code>
    </example>
</member>

Фактический вывод

---

Я использую графический интерфейс Sandcastle File Builder версии 2018.5.29.0.

Я пытался показать что-либо в свойствах проекта, что дало мне много нежелательных дополнительных элементов в документации, но ни один из них не дал мне <return> или <params>.

Answer 1

По какой-то причине, если я делаю проект Sandcastle в Visual Studio, проблема решается, и я также получаю секцию синтаксиса, что довольно приятно.Я до сих пор не понимаю, почему это не работает в графическом интерфейсе Sandcastle, но это работает для меня.Спасибо за вашу помощь

Редактировать: на самом деле я только что нашел настоящую проблему.Когда я включил проект, я подумал, что мне нужно изменить целевую платформу с 4.5 на 4.6.1, как в моем проекте C #.Странное его изменение не решает проблему, но делает новый проект без изменения этого свойства.На всякий случай, если у кого-то есть такая же проблема.

Answer 2

Можете ли вы поставить галочку

Включить предупреждение «отсутствует документация» для отсутствующих элементов комментариев XML

для тегов <param> и <return>?Это что-то меняет?Вы должны как минимум получить разделы Parameters и Return Value в своей документации.

---

Если это тоже не сработает, сделайтеУбедитесь, что вы отметили

XML-файл документации

в Visual Studio на свойствах проекта. Страница сборки, как описано здесь .