|
|
<!--------------------------------------------------------------------------->
<!-- INTRODUCTION
The Code Project article submission template (HTML version)
Using this template will help us post your article sooner. To use, just
follow the 3 easy steps below:
1. Fill in the article description details
2. Add links to your images and downloads
3. Include the main article text
That's all there is to it! All formatting will be done by our submission
scripts and style sheets.
-->
<!--------------------------------------------------------------------------->
<!-- IGNORE THIS SECTION -->
<html>
<head>
<title>The Code Project</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<Style>
BODY, P, TD { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 10pt }
H2,H3,H4,H5 { color: #ff9900; font-weight: bold; }
H2 { font-size: 13pt; }
H3 { font-size: 12pt; }
H4 { font-size: 10pt; color: black; }
PRE { BACKGROUND-COLOR: #FBEDBB; FONT-FAMILY: "Courier New", Courier, mono; WHITE-SPACE: pre; }
CODE { COLOR: #990000; FONT-FAMILY: "Courier New", Courier, mono; }
</style>
<link rel="stylesheet" type=text/css href="http://www.codeproject.com/styles/global.css">
</head>
<body bgcolor="#FFFFFF" color=#000000>
<!--------------------------------------------------------------------------->
<!------------------------------- STEP 1 --------------------------->
<!-- Fill in the details (CodeProject will reformat this section for you) -->
<pre>
Title: Morefast Doc-Comments Maker
Author: Manish Pansiniya
Email: manish_ld@rediffmail.com
Environment: VC++ 6.0, Win2000
Keywords: Add-In, Comment
Level: Intermediate"
Description: This Add-In Is About Easy File/Function Commenting ...
Section AddIn
SubSection General
</pre>
<hr width=100% noshade>
<!------------------------------- STEP 2 --------------------------->
<!-- Include download and sample image information. -->
<ul class=download>
<li><a href="CppCWiz_bin.zip">Download BinFile - XXX Kb </a></li>
<li><a href="CppCWiz_Code.zip">Download source - XXX Kb</a></li>
</ul>
<!------------------------------- STEP 3 --------------------------->
<!-- Add the article text. Please use simple formatting (<h2>, <p> etc) -->
<p><H2>General :</H2>
Hi Friends, While doing project, i got many difficulties related to comment. I did it myseft and with morefast add-In tool after implementing little file/function commenting functionality. So i have made this little but useful add-in to help another my kind of people of people who want to organize their code. I want to extend this add-in and have many idea but due to time problem ( which everyone have.. ) i am posting only this three featured addin.
</p>
<p>
There are three files.<BR>
<UL>
<LI>CppCWiz.dll
<LI>Macro.txt
<LI>CommTemp.txt
</UL>
Extract these files in one directory.
<H2>How can you make New Macro.</H2><BR>
1) First #@ sign. 2) Macroname Covered With $. 3) then = YOURSTRING 4) Last @#.
<BR>eg.<BR>
#@ $UD_COMPANYNAME$ = Sahajanand Software Private Ltd. @#<BR>
#@ $MyName$ = Manish Pansiniya @#<BR>
<H2>How can you make changes To Template.</H2><BR>
<pre>
//
// 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]
</pre>
Now , You can see macro with $ signs. These macros are defined in macro.txt. We saw that in previous section. $FILENAME$ is my internal macro which you can't change.
<BR> Internal Macros <BR>
<pre>
"$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.</pre>
So you can't use these macro except author. You must define author macro in macro.txt file. Next macro is $ASKTOUSERDESCRIPTION$. If you want to ask any information from user then write first ASKTOUSER and then your description of text. like this...<BR>
<pre>
$ASKTOUSERFUNCTION
$ASKTOUSERCHANGELOG etc.</pre>
<H2> Add-In Buttons Descriptions ( AddIn Utilities ). </H2>
<B>FileComment Button</B> :- This button is file comment. File comment template is stored in CommTemp.txt file. You can change file comment by changing file comment template from CommTemp.txt file. <BR><BR>
<B>FunctionComment Button</B> :- This button is function comment. function comment template is stored in CommTemp.txt file. You can change function comment by changing function comment template from CommTemp.txt file. <BR><BR>
<B>ChangeLog Button</B> :- This button is ChangeLog comment. ChangeLog comment template is stored in CommTemp.txt file. You can change ChangeLog comment by changing function comment template from CommTemp.txt file. <BR><BR>
<B>Option</B> :- Option is not fully implemented but you can open macro.txt and Commtemp.txt file from dialog. and you can see online your macros.
</p>
<p>If any problem persist tell me on : manish_ld@rediffmail.com or give reply on this article.</p>
<!------------------------------- That's it! --------------------------->
</body>
</html>
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
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
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
Submit an article or tip