Does SC support C++/CLI?

Sep 1, 2008 at 8:16 AM
Hi,

basically, the subject already says it all: Does SC support C++/CLI?

Cheerio,


Golo
Sep 1, 2008 at 8:44 AM
>>Golo: basically, the subject already says it all: Does SC support C++/CLI?

Basically, yes. There are, however, some issues, which are not Sandcastle problems but the
C++/CLI issues - but these could be fixed easily in the tools.

If the main source is in C# or VB.NET there may be issues with some of the syntactic sugar
stuff like the extension method support, since this is not supported in C++/CLI.
However, if the main source is in C++/CLI any compiler issue/limitation can be fixed by tools.

Best regards,
Paul.
Sep 1, 2008 at 10:13 AM
Hi Golo,

Sandcastle's MRefBuilder tool uses CCI to inspect managed assemblies and then generates a reflection file from which HTML documentation is inferred for each API.  Therefore, if you use C++/CLI, or any managed language for that matter, then Sandcastle can document the assemblies.  In other words, Sandcastle documents .NET assemblies regardless of the language in which they were written.

If you also have XML documentation that the compiler produced from code comments, Sandcastle will include it as well.  Compilers output XML documentation using a sort of well-known schema, although there are issues with some compilers, such as C++ and VB.NET, not properly resolving cref attributes in certain scenarios.

The syntax section that is included in the auto-generated HTML topics don't account for all managed languages, however.  Although there is a C++ syntax declaration included already in the out-of-the-box configuration files.

- Dave