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

#c_sharp #cpp_cli #комментарии

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

Ответы

Ответ 1

В .NET для всех языков используется стандартный подход: xml-комментарии, начинающиеся
с трёх символов ///. После компиляции dll будет создан файл xml, содержащий документацию.
При наличии этого файла комментарии к методам данной библиотеки будут видны в C# и
любом другом языке.

Подробнее смотрите по ссылке Документация XML (Visual C++).

Чтобы файл документации создавался в процессе компиляции нужно указывать параметр
/doc компилятора. Смотрите раздел "Установка данного параметра компилятора в среде
разработки Visual Studio".



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


Ответ 2

В чистом C++ - никак, вы же через P/Invoke вызываете нативные функции. Можно использовать
библиотеку на Managed C++, и сформировать .xml описание функций, которые в ней содержатся.


Ответ 3

Я бы в сторону XML-документации смотрел (то есть, в отдельном файле), думаю, получится
все необходимое реализовать, но писать этот файл, вероятно, придется, вручную.