FeaturesList FrequentlyAskedQuestions InstallationAndUsage KnownIssues VersionHistory
CR_Documentor
DevExpress 9.1.3+ Users: You need to upgrade to CR_Documentor version 2.3.0.1 or later.
DevExpress 9.1.2 Users: You need to use CR_Documentor version 2.3.0.0.
Users of earlier DXCore versions: You need to use CR_Documentor version 2.2.1.0 or earlier. Check out the downloads list to see which one is appropriate for your situation.
Writing XML documentation comments in .NET can be troublesome sometimes because you can't really see what it's going to look like - you have to compile the code, then take the extracted XML doc and feed it to a rendering engine like Sandcastle, then wait for the compiled help to come out so you can read it.
CR_Documentor is a plugin for DXCore that allows you to preview what the documentation will look like when it's rendered - in a tool window inside Visual Studio.
Example
Your inline XML docs...
/// <summary>
/// This method returns a string.
/// </summary>
/// <returns>Empty string is the return value.</returns>
public string Method()
{
return "";
}...get previewed in the window:
...and here's what it looks like in the context of Visual Studio: