Страницы

Поиск по вопросам

понедельник, 25 февраля 2019 г.

Комментарии из c++/cli (dll) в с#

Как добавить комментарий в C++ CLI, чтобы потом при использовании методов данной dll в c# можно было видеть комментарии к функциям и параметрам?


Ответ

В .NET для всех языков используется стандартный подход: xml-комментарии, начинающиеся с трёх символов ///. После компиляции dll будет создан файл xml, содержащий документацию. При наличии этого файла комментарии к методам данной библиотеки будут видны в C# и любом другом языке.
Подробнее смотрите по ссылке Документация XML (Visual C++)
Чтобы файл документации создавался в процессе компиляции нужно указывать параметр /doc компилятора. Смотрите раздел "Установка данного параметра компилятора в среде разработки Visual Studio".

Не могу не отметить: хоть там и написано, что переведено вручную, но перевод настолько корявый, что лучше переключаться на английский язык, если вы им владеете. А также могу посоветовать использовать справочные материалы по другим языкам, например Комментарии к XML-документации (Руководство по программированию на C#)

Комментариев нет:

Отправить комментарий