documentation - Documenting C++/CLI library code for use from c# - best tools and practices? -


I am working on a project where C ++ / Clear Library is primarily being used by AC # applications is.

Is there any way to make the code's comments in C + # / CLI visible within C # intelligences within Visual Studio?

Do not believe that what is the best way to document C ++ / CLI code to make it easy to use in C # (and within C ++ / Cli Course)? What do you think about XML comments vs. other tools (that)?

I've got it to work as follows:

  1. < P> Use XML style comments for your C ++ / CLI header entries. This means that the complete XML comment is required (minimum - slash comment, gt;

    tag at minimum)

  2. Ensure that The C ++ compiler option is turned on This should generate an XML file with documentation in the name of your assembly (MyDll.xml).

  3. Ensure that the C # project refers to your assembly MyDll.dll where MyDll Xml also exists in the same folder. When you mouse on a reference from the assembly, the MS Visual Studio will load the documentation

This works for me in Visual Studio 2008. On the assembly created for NET 3.5


Comments

Popular posts from this blog

c++ - Linux and clipboard -

What is expire header and how to achive them in ASP.NET and PHP? -

sql server - How can I determine which of my SQL 2005 statistics are unused? -