Is xml documentation file (comment.xml) used?

Topics: Developer Forum
Nov 20, 2012 at 8:29 AM

It seems that xml documentation file (comment.xml) is not used in the building of the resulting help file (Sandcastle installation: Sandcastle\Examples\Sandcastle\build_Sandcastle.bat).

All info is getting by MRefBuilder from dll into

Is it possible to use only comment.xml as a start point, without using dll?


Nov 20, 2012 at 8:27 PM

No, Sandcastle needs to parse the DLL in order to generate the API information (base classes, inherited members, visibility (i.e. public/private/protected), etc.).  The reflection information and the XML comments are used by BuildAssembler to generate the API member topics.

If your intent is to produce a help file that is not based on an assembly, you can use conceptual content (MAML topics).  SHFB has a plug-in that turns off the API build steps so that you can produce a help file from just conceptual content.  You'll find SHFB in the All Programs Menu under Sandcastle Help File Builder.  It provides more features and is easier to use than the command line tools and example scripts provided with Sandcastle alone.