You can use Rich Comments to apply text formatting to comments in the Visual Studio code editor.
This document contains the following sections:
CodeRush supports the following Markdown-like formatting syntaxes:
For example, you can format the Copyright Header's text and add your company's logo.
//----------------------------------------------------------------------- // <copyright file="D:\Projects\CodeRushDemo\CodeRushDemo\Program.cs" company="Developer Express Inc"> // !(etc\DevExpress-Logo-Medium-Color.png) // Author: _**CodeRush User**_ // *Copyright (c) Developer Express Inc. All rights reserved.* // </copyright> //-----------------------------------------------------------------------
For CodeRush to render a comment similar to the one displayed above, enable the Rich Comments feature.
The following formatting can be applied to selected text inside a comment in CodeRush.
CodeRush can also apply formatting (bold, italic, etc.) to comments if you choose the appropriate command from the Embed Selection action menu. To invoke the menu, select text inside a comment and press Ctrl + . or Ctrl + ~. In the invoked menu, open the Embed Selection group and choose the embedding from the list.
To enable the Rich Comments feature, use the Editor | All Languages | Rich Comments options page;
or click the Toggle Rich Comments toolbar button.
You can cancel markdown characters:
You can also disable markdown formatting in the Rich Comments options page. Deselect the "Show markdown formatting (bold, italic, strikethrough, underline, etc.)" option on the Editor | All Languages | Rich Comments options page.
CodeRush allows you to highlight important comments, question comments, and task-based comments.
Use the following tokens to highlight task-based comments in the color:
You can change the highlight colors on the Rich Comments options page.
CodeRush gives you the ability to use markdown to create large or small comments.
You can also use the hashtag character ("#") to specify comment size.
CodeRush decreases comment contrast as the font size increases, and increases contrast as comment size decreases. You can change the contrast, or assign a custom color to each of the large and small comment font sizes. Use the "sized comment color" setting on the Rich Comments options page:
To enable this functionality, make sure you check the "Change comment font size and color using ++, --, #, ##, etc" checkbox:
CodeRush provides beta support for LateX formulas in Rich Comments.
The LaTeX Formulas Support feature ships disabled by default. You can enable LaTeX formula support on the Rich Comments options page.
CodeRush provides templates to facilitate LaTeX formula creation. See the Templates for LateX Formula Creation topic for more information.
Use one of the formats below to specify the formula’s foreground color, background color, and size.
The following screencast shows the LaTeX formula with a different background color, foreground color, and size.
The following message is displayed when your LaTeX code is broken:
You can see the supported image formats in the Imaging Overview MSDN article.
Right-click an image to invoke the context menu:
The following commands are available:
Click on an image to select it.
Drag one of the image sizing handles.
Select the code and images (with the mouse or Shift+navigation keys);
Cut or copy, and paste the code and images into any source file in the solution.
Press undo/redo keys (e.g., Ctrl+Z or Ctrl+Y), or invoke these actions through the Visual Studio undo/redo toolbar buttons.
Add or remove spaces before the leading comment delimiter.
You can add a backtick (`) character after the leading comment delimiter to hide this delimiter.
Make sure you check "Hide comment delimiters (`) when a backtick follows the leading comment delimiter" checkbox to enable this functionality.
In the Action on Image Click menu you can add one of the following image-click actions:
For example, the following image shows how to customize the open URL action on an image click.
The customers can click the link that takes them to the devexpress.com community site.