473,386 Members | 1,763 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,386 software developers and data experts.

VB.NET XML Documentor

When I type in the three apostrophes (above a class, method, etc.) and press
enter, the IDE generates the
following lines.

''' <summary>
'''
''' </summary>
''' <remarks></remarks>

If there are arguments in the sig line, they are also tagged.

I would like to add more to the default template. (more tags) I can't see
where this is coming from. Does anyone know if there is a way to modify
this? Or even what template file this is being generated from?

I know that I can add tags after it is generated. I want to modify the
template so that my changes are the default (available everytime).

Thank you

Aug 1 '06 #1
1 1682
Gary,
Customize the xml below and save it as:

\Documents and Settings\<your user>\Application
Data\Microsoft\VisualStudio\8.0\VBXMLDoc.xml

and you should be set

---x--- cut here ---x---
<?xml version="1.0" encoding="utf-8" ?>
<XMLDocCommentSchema>

<CodeElement type="Module">
<Template>
<summary/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Class">
<Template>
<summary/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Structure">
<Template>
<summary/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Interface">
<Template>
<summary/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Enum">
<Template>
<summary/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Property">
<Template>
<summary/>
<param/>
<value/>
<remarks/>
</Template>
<CompletionList>
<exception cref=""/>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<summary/>
<value/>
</CompletionList>
</CodeElement>

<CodeElement type="Sub">
<Template>
<summary/>
<param/>
<remarks/>
</Template>
<CompletionList>
<exception cref=""/>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Function">
<Template>
<summary/>
<param/>
<returns/>
</Template>
<CompletionList>
<exception cref=""/>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<returns/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Operator">
<Template>
<summary/>
<param/>
<returns/>
<remarks/>
</Template>
<CompletionList>
<exception cref=""/>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<returns/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Declare">
<Template>
<summary/>
<param/>
<returns/>
<remarks/>
</Template>
<CompletionList>
<exception cref=""/>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<returns/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Field">
<Template>
<summary/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Delegate">
<Template>
<summary/>
<param/>
<returns/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<returns/>
<summary/>
</CompletionList>
</CodeElement>

<CodeElement type="Event">
<Template>
<summary/>
<param/>
<remarks/>
</Template>
<CompletionList>
<include file="" path=""/>
<param name=""/>
<permission cref=""/>
<remarks/>
<summary/>
</CompletionList>
</CodeElement>

<ChildCompletionList>
<c/>
<code/>
<example/>
<list type="">
<listheader>
<term/>
<description/>
</listheader>
</list>
<para/>
<paramref name=""/>
<see cref=""/>
<seealso cref=""/>
</ChildCompletionList>

</XMLDocCommentSchema>
---x--- cut here ---x---

--
Hope this helps
Jay B. Harlow [MVP - Outlook]
..NET Application Architect, Enthusiast, & Evangelist
T.S. Bradley - http://www.tsbradley.net
"Gary S" <Ga***@nospam.onlinewrote in message
news:6E**********************************@microsof t.com...
| When I type in the three apostrophes (above a class, method, etc.) and
press
| enter, the IDE generates the
| following lines.
|
| ''' <summary>
| '''
| ''' </summary>
| ''' <remarks></remarks>
|
| If there are arguments in the sig line, they are also tagged.
|
| I would like to add more to the default template. (more tags) I can't see
| where this is coming from. Does anyone know if there is a way to modify
| this? Or even what template file this is being generated from?
|
| I know that I can add tags after it is generated. I want to modify the
| template so that my changes are the default (available everytime).
|
| Thank you
|
Aug 4 '06 #2

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

3
by: Mike | last post by:
I am sort of new to SQL. I use MS-Access most of the time so I do not know if you can do this, but... In MS-Access there was a tool called documenter that would list out the table def's such as...
3
by: LoopyNZ | last post by:
Hi, I'd like to have a couple of buttons on my form so I can quickly access some Access (97) features: A) The relationships window; B) Tools - Analyze - Documenter (for relationships). ...
12
by: Ray | last post by:
I just completed a database and would like to prepare the documentation for it. As I have no experience to do so, can someone advise me the essential elements for the documentation and any example...
1
by: geoffblanduk_nospam | last post by:
I've written a small utility that will automatically document NUnit tests. It's based on NUnit2Report but has a few more features and handles inheritence of test cases correctly. I've put it up...
3
by: geoffblanduk_nospam | last post by:
Hopefully this will be of use to your all, an NUnit Documentation Utility. This takes the results of your NUnit tests and produces an HTML report (it's pretty colours so useful for showing to...
2
by: netcommander | last post by:
Hi, anyone used a 3rd party documentor that will extract the XML Comments from a ASP.NET 2.0 C# project into standalone documentation, e.g. in MSDN style format? You can't do it from within...
4
by: Arno R | last post by:
Hi all, I need to document a database, and I do need output in Word so that I can edit the output. I need to describe table and field structure, used objects, dataflow, workflow, What are...
1
by: infocaptor | last post by:
Hi Everybody, Using the show commands and information_schema tables, I have designed a dashboard for MySQL and that can also be used as a documentor for all MySQL objects. Its been tested only on...
2
by: Alex Eiswirth | last post by:
Hi, the Website of PHP Documentor seems to be down. It's been down for at least a week now. Anyone have idea what's going on? Thanks Alex Eiswirth http://www.eiswirth.de
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.