65.9K
CodeProject is changing. Read more.
Home

Active Comments 1.25

Andrei Levin
starIconstarIconstarIconstarIconstarIcon

5.00/5 (1 vote)

Oct 17, 2000

viewsIcon

88131

downloadIcon

989

This addin allows your source code to have references to external files, MSDN articles, voice comments etc.

Introduction

Active Comment is an add-in to Microsoft Developer Studio. It has been tested under VC++ v.6 with Service Pack 3 (and higher).

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.

If you found any errors or bugs I would be very grateful 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

  1. Copy "ActiveComments.dll" to the add-ins folder of Developer Studio: C:\Program Files\DevStudio\Microsoft Visual Studio\Common\MSDev98\AddIns
  2. In Developer Studio, go to the "Tools" menu and select "Customize...".
  3. Go to the "Add-ins and Macro Files" tab (the last one). Select the checkbox "Active Comments", and click "Close".
  4. Developer Studio adds a new toolbar with the Active Comments buttons:
Button
 Caption
 Description
 Comment Setup
  use for create new or modify exists active comment
 View Commentary  will executed linked to selected commentary reference
 List of all Active Comments
  will displayed list of all active comments in the current project
 Active comment clear
  delete selected active comment, but leave title in a text
 Delete Active Comment
  full delete selected active comment
 (and title from a text also will be deleted)
 Code Templates
  insert code template, which selected from the list
 Options
  Active Comment AddIn Options:
 clear history list, manage code templates list

To deactivate Active Comments, perform steps 2-3, but remove the selection from the Active Comments checkbox.

To completely uninstall Active Comments:

  1. Exit Developer Studio.
  2. Delete "ActiveComments.dll" from your Developer Studio add-ins folder.

Usage

  1. 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.
  2. 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.
  3. 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.

Acknowledgements

Special thanks to Nikolay Egipco.

History

Ver. 1.25:

  1. Was added protocol "MS-ITS" support: this is a new Microsoft protocol (began to be supported with IE 4.0) for work with chm-files. For more information see MSDN;
  2. ChangeCase functions were moved to the separate addin Active Tools
  3. New items were added to the UtilitesPage in the Options dialog:
    • Enable VC Editor wrapping: turn on/off wrapping to the Visual C++ editor windows;
    • Enable doubleclick on comments: turn on/off tracing mouse doubleclick on the active comments;
    • Enable template dialog repositon: turn on/off template dialog reposition
  4. Some minor bugs were corrected.

Ver. 1.21:

  1. Was added handler to event LeftButtonDblClick on the Active Comment (in the DevStudio's SourceEditor): after DblClick will be execute linked file or play voice comment or run MSDN;
  2. The method of definition of the active comment is advanced: now you can have several acomments in the one string;
  3. The function of adding code templates also is advanced: now AddTemplateDialog appears near at the place, where carret is found (KeyShortcut: Ctrl+Alt+J);
  4. Was corrected function of inserting code template: now everywhere in the code templates where there will be found a character "%s" will be inserted a selected text.
  5. Was corrected function of executing comment links to MSDN
  6. Was added Import/Export code templates
  7. Was corrected some minor bugs

Ver. 1.1:

  1. Was added options dialog (based on property sheet). It has following pages:
    • edit templates page - for add/edit/delete code templates
    • options page - yet it has only one option: Clear History List
  2. The error originating under following conditions was corrected:
    • you have a comment with link to a ,for example, web site;
    • then you have changed this link to link on a file and protocol from <http://> to <none>;but the protocol has not varied.
    Now it work correctly.
  3. The History List is limited to 20 records.

Ver. 1.0:

  1. Was added links-history in the CommentSetupDlg.
  2. Was added version control.
  3. Was added code templates.
  4. When you add a new active comment selected string is checked on finding in the block of the comment.

Updates

You can download latest version from my site