Groups | Blog | Home
all groups > visual studio .net documentation > september 2003 >

visual studio .net documentation : headings for Visual Studio source code files


ahmet sahan
9/21/2003 11:30:19 AM
Hi,

we use VS6 and VS.NET 2002 as software development platform for our
projects. an automated heading documentation is needed for our source code
files. At the beginning of each source code file (.h and .c) I gave a sample
below for the heading section that we want to put.
(Ex :
/*Date: xxxx
Author: xxxx
Definition: xxxx
.... */
#include <..>)
How can we do that? Is there any utility of VS or VS.NET for this kind of
documentation?

Thanks,

Ahmet Sahan

rogh NO[at]SPAM online.microsoft.com (
9/24/2003 6:13:18 PM
Ahmet, I apologize for the slow reply.
Visual Studio does not provide any built-in way to do this that I know of.
Following are a couple of suggestions, which I have not tried out. They are
just ideas:
1. You could try modifying the c++ templates for .cpp file and .h file to
have that text at the top. This would mean changing the installation files
on every developer's computer. These templates are found in the
<VSInstallDir>\vc7\vcprojectitems directory. Changing them will change the
base files that are added when a user chooses files from the "Add New Item"
dialog box, so altering these templates is not a change to make lightly.

2. You could try writing a VSA Macro that inserts the boilerplate code upon
click of a button or as a batch processor that does this automatically for
all files in the project.

--Roger
_______________________________
Roger Haight
Developer Division User Assistance
Microsoft Corporation

This posting is provided "AS IS" with no warranties, and confers no rights.

--------------------
[quoted text, click to view]
AddThis Social Bookmark Button