Ok, I can only tell you about how to use it with C# or C++ but hopefully it
will help you.
While in the editor, above a class declaration, constructor or method, you
do three slashes /// and automatically you get a summary and a /summary tag,
often followed by other lines inserted by the editor naming the parameters
and you put in comments between the <param> and </param> tags. Be aware that
this feature doesn't work automatically within a method, but it does work
for properties. I don't know if manually putting in the tags will work but
it might.
Then you run the build code comments web tool under tools when you've
compiled the code and make sure that you uncheck the pesky treat tags as
code that is always on by default. Make sure your pages go to the expected
directory which is supposed to be ProjectNameDirectory/CodeCommentReport. It
is supposed to do this by default but does not on my machine.
On XP sp2, you might have the issue outline in this info below, but it
explains what to do, works well. There will be a warning box that tells you
that you should check the box to keep modified files open, do not check that
or you will have over 100 pages of trash to close. Here is the info. I would
have provided the URL, but the site is down ..
Build Comment Web Pages in VS 2003 and Windows XP SP2
If you use documentation created by Build Comment Web Pages in Visual Studio
2003, you will experience problems viewing the documentation after upgrading
to Windows XP SP2. Currently, you can download the release candidate for
testing purposes here:
http://www.microsoft.com/technet/pro...p2preview.mspx The
service pack includes numerous fixes to improve the overall security of
Windows and Internet Explorer. Unfortunately, one fix disallowed a tag that
was generated by the Build Comment Web Pages feature.
Workarounds
The easiest workaround is to use Visual Studio to do a Find and Replace to
change the tag in the documentation to one that is accepted by Internet
Explorer.
1. Go to Edit/Find and Replace/Replace in Files
2. In the Find what: type: <!-- saved from url=(0007)http:// -->
3. In the Replace with type: <!-- saved from url=(0014)about
:internet -->
4. Ensure regular expressions is not checked.
5. In the look in type the directory where the web pages are stored.
6. Click Replace All to execute the search.
Background
The tag is that is the problem here is called the "Mark of the Web". IE
adds the Mark of the Web to web pages that are saved from the internet.
This way IE can detect that the content was originally from the internet
zone and it should be treated as such. In this instance, the page was not
saved from the internet but Visual Studio used http:// to force it to the
internet zone. In Windows XP SP2, the IE team did work to tighten up the
items which were permissable and http:// was accidentally excluded. The IE
team assures me that the original mark of the web that is generated by VS
2003 does not represent a security risk.
If you have any questions, please let me know.
-Sean Laberee
posted on Friday, July 16, 2004 5:07 PM by VSEditor
Comments
"Jianwei Sun" <js***********@gmail.com> wrote in message
news:eH**************@TK2MSFTNGP15.phx.gbl...
I remember there is a tool which automatically put some simple comments on
the properties and methods. I cannot find it anywhere, can somebody help me
on this.
