This plug-in inserts comments before methods in your source files. The comments are completely customizable, and can be used to document methods or to simply provide a visual separator between methods. You can comment the current method or an entire file.
This plug-in registers the following commands, which you can bind to keyboard shortcuts or add to the CodeRush toolbar:
This command brings up the Separate Method Comments dialog, which looks like this:
This dialog allows you to specify up to nine different method comment templates. You can also specify options for the method commenting on this page.
Comment templates should be syntactically-correct comments, and can contain any of the supplied macros:
Note: The page control tab that is active when you click OK will be the "default comment template" for the method commenting commands, documented below.
This command adds special comments before all methods in the current file, using the default comment template. You can override the default comment template, selecting a different comment template instead by passing its index as a parameter to this command. For example, to separate all methods in the current file with the comment template on tab #2, use this command:
This command adds a special comment before the current method, using the default comment template. You can override the default comment template, selecting a different comment template instead, by passing its index as a parameter to this command. For example, to add a comment to the current method using the comment template on tab #9, use this command:
For CodeRush 5 and above, download the CR_MethodCommentButtons.zip file from the Buttons link and unzip the contents into your CodeRush\Toolbar\Library directory. This will provide default toolbar buttons for this plug-in.
For convenience, this plug-in registers several toolbar buttons in the Commenting category (after installing, just drag across to your toolbar using the Buttons page of the CodeRush Options dialog). The image above demostrates setting up the Commenting buttons in CodeRush 5. The toolbar button setup window in CodeRush versions 6 and higher can be accessed from the CodeRush Options menu by selecting Editor / Toolbar / Buttons.
This plug-in is not the property of Developer Express; it is the sole property of its author. As such, Developer Express cannot be held liable for any incidental damages that may be related to the usage of this plug-in.