XML Documentation Addin or tool?

[Jeff Pipes]

Does anyone know of any third-party addin or tool that provides XML documentation
capabilities to Visual Basic.NET? This is a great feature C# has but VB lacks.

-Jeff

[Rob Teixeira]

I was actually working on one. To be honest though, I've become disenchanted
with the C# xml documentation. It's limited, it adds a lot of crap to the
code, and there's no standard way to enforce change management/workflow on
it either. Nice feature, but i simply don't like the implementation.
Anyway, the software I was working on was an add-in for .NET (any language).
You manage the documentation entirely within the addin, and there are dockable/hideable
windows too. The idea is, you work on a method, and it displays the documentation
fields in the window. Behind the scenes, it keeps the documentation in a
database, with full version/access control, where it belongs. However, it
does use an IDocStorage interface, so you can substitute storage streams
- effectively swap the doc writing between DB or code comments - you pick.
It also reads VB source files, and adds XML code comments, such as the following
if you choose Source file strorage.

''<summary>method description here</summary>
''<author>RTeixeira</author>
Public Function DoSomething() As Integer

End Function

You can create custom doc fields as well. In addition, it uses an IDocWriter
interface, so you can assemble your output documentation any way you want.
The default is to create a set of XML docs. You can optionally apply a transform
to the XML to generate XHTML with styles of your choice. Theoretically, you
could create RTF or any other type of documentation.

I promise to get back to it when I get my design-time immediate window working
100%

-Rob

"Jeff Pipes" <JeffP622@msn.com> wrote:
>
>Does anyone know of any third-party addin or tool that provides XML documentation
>capabilities to Visual Basic.NET? This is a great feature C# has but VB
lacks.
>
>-Jeff

[Garry Mc]

Rob

Sounds interesting, look forward to hearing more in the future....

Garry Mc

"Rob Teixeira" <RobTeixeira@@msn.com> wrote:
>
>
>I was actually working on one. To be honest though, I've become disenchanted
>with the C# xml documentation. It's limited, it adds a lot of crap to the
>code, and there's no standard way to enforce change management/workflow
on
>it either. Nice feature, but i simply don't like the implementation.
>Anyway, the software I was working on was an add-in for .NET (any language).
>You manage the documentation entirely within the addin, and there are dockable/hideable
>windows too. The idea is, you work on a method, and it displays the documentation
>fields in the window. Behind the scenes, it keeps the documentation in a
>database, with full version/access control, where it belongs. However, it
>does use an IDocStorage interface, so you can substitute storage streams
>- effectively swap the doc writing between DB or code comments - you pick.
>It also reads VB source files, and adds XML code comments, such as the following
>if you choose Source file strorage.
>
>''<summary>method description here</summary>
>''<author>RTeixeira</author>
>Public Function DoSomething() As Integer
>
>End Function
>
>You can create custom doc fields as well. In addition, it uses an IDocWriter
>interface, so you can assemble your output documentation any way you want.
>The default is to create a set of XML docs. You can optionally apply a transform
>to the XML to generate XHTML with styles of your choice. Theoretically,
you
>could create RTF or any other type of documentation.
>
>I promise to get back to it when I get my design-time immediate window working
>100%
>
>-Rob
>
>"Jeff Pipes" <JeffP622@msn.com> wrote:
>>
>>Does anyone know of any third-party addin or tool that provides XML documentation
>>capabilities to Visual Basic.NET? This is a great feature C# has but VB
>lacks.
>>
>>-Jeff
>