DocPreviewXML Documentation Preview. Generates HTML preview of the code XML documentation from the comment region under the current caret position. The preview window can be accessed from Menu->View->Other Windows.
|
The extension has been built for VS2022 and higher. For older (pre VS2022) releases please visit https://github.com/oleg-shilo/Retired-VSIX. Description Many documentation authoring tools (e.g. GhostDoc) do an excellent job but fall short assisting with the actual development of the documentation - editing XML code comments. DocPreview is different. It provides an instantaneous preview of a given single XML comments block. DocPreview assists with validating the user input for being compatible with the documentation authoring tools (e.g. Sandcastle). Thus developers can efficiently modify the content to deal with the typical editing problems (e.g. typos, misspells). Special thanks to Marek Stoj, author of ImmDoc.NET. Using DocPreview Using DocPreview is straightforward. Open the preview window from Menu->View->Other Windows->Xml documentation preview. Now if you place the cursor inside of the XML code comments the documentation preview will be rendered when you press the refresh icon/button. Alternatively, you can tick the 'Auto refresh' checkbox and the preview will be generated automatically when the active document current line is changed. The below is the screenshot that illustrates the use of DocPreview:
|
