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 CodeRush that allows you to preview what the documentation will look like when it's rendered - in a tool window inside Visual Studio.
Copyright 2004 CR_Documentor Contributors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This product requires CodeRush for Visual Studio .NET 14.2 or later.
CodeRush is a Visual Studio extension from Developer Express, Inc.: https://www.devexpress.com/Products/CodeRush/
- Open an instance of Visual Studio.
- From the DevExpress menu, select "Tool Windows," then "Documentor." This will show the Documentor window.
- When working in a source file with XML documentation, watch the Documentor window as you edit your XML comments. It will contain a preview of what your comments will look like when rendered into end-user documentation.
While viewing a source code file, CR_Documentor provides an additional context menu. Different options appear based on whether you are inside an XML doc comment or not; and whether you have text selected or not.
To build the CR_Documentor source, you'll need...