CodeGuru content and product recommendations are editorially independent. We may make money when you click on links to our partners. Learn More.
Active Comment is an add-in to Microsoft Developer Studio. It has been tested
with Version VC++ 6 and Service Pack 3.
This addin provides active comments using your source code. You can reference
your code with external files, e-mail addresses, set links to internet sites,
MSDN articles, or you can insert voice commentary to your source, etc.
This version of Active Commentary is the first implementation. If you found
any errors or bugs I would be very greatful to recieve feedback.
Your suggestions would be highly appreciated.
Disclaimer: This software is provided as-is and with no implied warranty
of any kind. Please don’t place any blame on me if it does something untoward
to your system.
Installation
- Copy ActiveComments.dll to the add-ins folder of Developer Studio:
C:\Program
Files\DevStudio\Microsoft Visual Studio\Common\MSDev98\AddIns - In Developer Studio, go to the “Tools” menu and select “Customize…”.
- Go to the “Add-ins and Macro Files” tab (the last one). Select the checkbox
“Active Comments”, and click “Close”. - Developer Studio adds a new toolbar with the Active Comments buttons:
1 2 3 4 5 6
7 8 9 10 11
|
Button
|
Caption
|
Description
|
|
1
|
Comment Setup
|
use for create new or modify exists active comment |
|
2
|
View Commentary | will executed linked to selected commentary reference |
|
3
|
List of all Active Comments
|
will displayed list of all active comments in the current project |
|
4
|
Active comment clear
|
delete selected active comment, but leave title in a text |
|
5
|
Delete Active Comment
|
full delete selected active comment (and title from a text also will be deleted) |
|
6
|
Change case to upper
|
Change case of selected text to upper |
|
7
|
Change case to lower
|
Change case of selected text to lower |
|
8
|
Capitalize this string
|
Capitalize selected text |
|
9
|
Convert space to tab
|
Convert space at the begin and end of selected text to tab |
|
10
|
Code Templates
|
insert code template, which selected from the list |
|
11
|
About
|
About Active Comment AddIn |
To deactivate Active Comments, perform steps 2-3, but remove the selection
from the Active Comments checkbox.
To completely uninstall Active Comments:
- Exit Developer Studio.
- Delete Active Comments.dll from your Developer Studio add-ins folder.
Usage
- Move the cursor to the row where you want to insert an active comment or
select the text which you want to make an active comment. - Click the button "Comment Setup" and in the following dialog enter
the comment title (it will be displayed in the source). Point a reference
to file (or MSDN article, web page, e-mail, etc.). If you want to make a voice
comment, click on the button
"Show Record Controls", make a record and save it (name of wave
file will be generated automatically). Click OK. - Active comment will be displayed. For example:
// [[->Link to the
MSDN]]
If you want to manage all of active comments in the project, choose the command
“View All Comments”. And in the following dialog you can edit, delete and execute
active comments.
Limitation: in one line it is possible to have only one active commentary.
Acknowledgements
Special thanks to Nikolay Egipco.
Downloads
Download Visual Studio Add-In – 49 Kb
Download source code – 56 Kb
