Добавить документацию XML для именованных элементов в ValueTuple - PullRequest
0 голосов
/ 06 мая 2018

С ValueTuple в C # 7 теперь можно писать методы и свойства, которые возвращают или используют составные объекты без явного объявления типа. Однако эти именованные кортежи могут привести к путанице, если не предоставлена ​​документация.

Поскольку основным и, вероятно, наиболее удобным способом документирования библиотек является использование документации XML, есть ли способ использовать документацию XML для предоставления описания переменных в именованном кортеже?

Я знаю, что очевидным решением является объявление типа и его документирование соответствующим образом. Однако, учитывая, что по некоторым «причинам», которые не могут быть выполнены, возможно ли XML-документирование элементов данных в ValueTuple?

Примечание: Аналогичный вопрос был задан до появления ValueTuple.

1 Ответ

0 голосов
/ 07 мая 2018

C # не имеет специального синтаксиса для документирования именованных элементов кортежа, вам придется использовать обычные элементы <returns> и <param> и объяснить словами, что содержится в каждом названном элементе.

Хотя есть предложение добавить эту возможность в язык .

...