You should of course modify this comment or add text to it when required. for checking your code with FxCop), an XML comment will be generated for you. In case you don't have any comments for a public function or class, but may need XML comments (e.g.It also allows you just to write normal comments (which is obviously faster than writing a summary block) and then just press } at the end of the function to convert it automatically (and then add parameters, etc. to XML comments automatically, this can come in handy. The commenter can convert normal comment of classes, methods, etc.It will also remove any unnecessary empty lines between the region code and the directives. If requested, the Commenter will put a Using directives region around all your using directives, like Visual Studio 2005 does when creating new classes.The cool thing about this is, it gets updated every time when you modify a file, so you can always very easily see when the code was created and when it was modified the last time. Customable header comment: In each source file you edit, a customable header will be added at the top of the file.The Commenter will only do its work when you press '}' to end a code block, the only exception is when you double-click on an auto-generated comment, then your cursor will jump to the class or method. Let's take a look at some actual code and how it would look when using Commenter: Commenter - FeaturesĪs you can see in the image above, there are several features supported in Commenter. The Commenter could also be implemented as a native Visual Studio plugin, but this would be much harder (parsing, etc.), also anyone using my plugin should also useCodeRush to improve his development speed.
I will also cover how to write and use a CodeRush plugin, it seems like there is no tutorial on the net for this. Note: I have nothing to do with the Developers of CodeRush, I just like their tool and think it's easier to write Visual Studio plugins with it. Just be sure to change the start-program to the correct devenv.exe too (for testing).
For an updated feature list and many more screenshots, check out this blog entry! This article is still based on the CR_Commenter version 1.0, since 2004 CR_Commenter was updated 9 times already and is in version 1.9 right now ().
(Note: Since v1.8 all files are for Visual Studio 2008.) The project files use Visual Studio 2003, but you can convert them to Visual Studio 2005 or Visual Studio 2002 as well and everything should work fine too. Support for VB.NET might be added if requested, don't know if VB guys would like such a feature. Currently Commenter supports only C#, but C ++ might work too (but may need some additional testing). Basically Commenter will help you to comment your code and make it easier to navigate through your code.
Download Commenter Installer (v1.9) - 80.74 KBĬommenter is a plugin for CodeRush, which is an addin for Visual Studio (Visual Studio 2002, 2003, 20 are supported).Download source files (v1.9) - 89.21 KB.