Click here to Skip to main content
Click here to Skip to main content
Go to top

Morefast Doc-Comments Maker

, 5 Dec 2002
Rate this:
Please Sign up or sign in to vote.
This Add-In Is About Easy File/Function Commenting ...

Introduction

While writing a project I got into many difficulties related to commenting. I solved these using the morefast add-In tool after implementing a little file/function commenting functionality. So I have made this little but useful add-in to help people who want to organize their code. I want to extend this add-in and have many ideas but due to time problems (which everyone has) I am posting only this three featured add-in.

There are three files.

  • CppCWiz.dll
  • Macro.txt
  • CommTemp.txt
Extract these files in one directory.

How you can make a new macro:

  1. First #@ sign.
  2. Macroname Covered With $.
  3. then = YOURSTRING
  4. Last @#.
    e.g.
    #@ $UD_COMPANYNAME$ = Sahajanand Software Private Ltd. @#
    #@ $MyName$ = Manish Pansiniya @#

How can you make changes to the template:

	//
	// Default Template For File Comment Look Like This Look Like This.
	//
	[FILE COMMENT]
	/*******************************************************************
	 *                                     $FILENAME$
	 *******************************************************************
	 *	AUTHOR      : $AUTHOR$
	 *	PROJECT     : $PROJECT$	
	 *	DESCRIPTION : $ASKTOUSERDESCRIPTION$  
	 *  ----------------------------------------------------------------
	 *	Revision History :    
	 *  $DATE$  $USERNAME$    Initial Version.  
	 *	        
	 *  ----------------------------------------------------------------
	 *                         Copyright (c) 2002 $UD_COMPANYNAME$  
	 ******************************************************************/
	[~FILE COMMENT]
	
Now, you can see the macro with $ signs. These macros are defined in macro.txt. We saw that in the previous section. $FILENAME$ is my internal macro which you can't change.  Internal fixed macros:
	"$FILENAMEWPATH$" - FileName With Path
	"$FILENAME$"      - FileName
	"$SELECTION$"     - Current Selection In Workspace.
	"$PROJECT$"       - Project Name.
	"$AUTHOR$"        - Author Name. You must provide this in macro.txt.
	"$DATE$"          - Today's Date.
So you can't use these macros except author. You must define author macro in macro.txt file. Next macro is $ASKTOUSERDESCRIPTION$. If you want to ask any information from the user, then define ASKTOUSER and then your description, e.g.
	$ASKTOUSERFUNCTION
	$ASKTOUSERCHANGELOG etc.

Add-In Buttons Descriptions (AddIn Utilities)

FileComment Button :- This button is file comment. File comment template is stored in CommTemp.txt file. You can change the file comment by changing the file comment template in the CommTemp.txt file.

FunctionComment Button :- This button is the function comment. The function comment template is stored in the CommTemp.txt file. You can change the function comment by changing the function comment template in the CommTemp.txt file.

ChangeLog Button :- This button is the ChangeLog comment. The ChangeLog comment template is stored in CommTemp.txt. You can change the ChangeLog comment by changing the function comment template in the CommTemp.txt file.

Option :- Options are not yet fully implemented but you can open macro.txt and the Commtemp.txt file using Explorer, and you can see online your macros.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Manish Pansiniya
Founder IntelliPro Solutions Pvt. Ltd.
India India
A 8 or something in .NET, living in Ahmedabad, India owned IntelliPro Solutions Pvt. Ltd..
 
Currently working on .NET technologies, MVC and Silverlight.
 
My little blog is for helping community with the solution for problems or helping them to understand new technology. You can reach to my blog at http://maniish.wordpress.com.
 
To contact me, post comment here or email me at manish AT iprospl.com
Group type: Organisation (No members)


Follow on   Twitter

Comments and Discussions

 
QuestionOnly for VS 6.0 ? Pinmemberleandrobecker10-Dec-02 4:43 
AnswerRe: Only for VS 6.0 ? Pinmembermkcx7-Jul-04 3:41 
GeneralNice! PinmemberMustafa Demirhan6-Dec-02 12:46 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web02 | 2.8.140916.1 | Last Updated 6 Dec 2002
Article Copyright 2002 by Manish Pansiniya
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid