VB.NET XML Documentor

[Gary S]

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

[Jay B. Harlow [MVP - Outlook]]

Re: VB.NET XML Documentor

Gary,
Customize the xml below and save it as:

\Documents and Settings\<your user>\Applicati on
Data\Microsoft\ VisualStudio\8. 0\VBXMLDoc.xml

and you should be set

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

<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>

<ChildCompletio nList>
<c/>
<code/>
<example/>
<list type="">
<listheader>
<term/>
<description/>
</listheader>
</list>
<para/>
<paramref name=""/>
<see cref=""/>
<seealso cref=""/>
</ChildCompletion List>

</XMLDocCommentSc hema>
---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" <GaryS@nospam.o nlinewrote in message
news:6EB38DF7-8C07-4D5F-B40B-030A9A4FF9CB@mi crosoft.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
|