Extensible XML documentation?

  • Thread starter Thread starter Phill. W
  • Start date Start date
P

Phill. W

Whilst hammering away cutting VB.Net code, I'm hearing (mostly
from my C#-cutting colleagues) about XML documentation that
can be produced from our .Net projects. Now, I've only scratched
the surface about this (and already worked out that I need an add-in
to do this from VB.Net) I'd like to ask:

Is it possible to extend the output produced?

[In the absence of Java's "Checked Exceptions"] I'd like, if possible,
to add into these documents information about what Exceptions can
be thrown by my code. That way, at least other Developers will have
half an idea of what my code might do to them.

TIA,
Phill W.

Exceptions
 
I just asked this same questoin yesterday. check out gotdotnet for the VB
Commenter. I started using it this morning, seems pretty decent so far, but
not quite as good as the C# commenter. Which I like more. =)
 
Just you wait for Whidbey ;-)

--
Happy to help,
-- Tom Spink
([email protected])

"Go down with your server"

http://dotnetx.betasafe.com >> On The Mend

Please respond to the newsgroup,
so all can benefit


CJ Taylor said:
I just asked this same questoin yesterday. check out gotdotnet for the VB
Commenter. I started using it this morning, seems pretty decent so far, but
not quite as good as the C# commenter. Which I like more. =)


Phill. W said:
Whilst hammering away cutting VB.Net code, I'm hearing (mostly
from my C#-cutting colleagues) about XML documentation that
can be produced from our .Net projects. Now, I've only scratched
the surface about this (and already worked out that I need an add-in
to do this from VB.Net) I'd like to ask:

Is it possible to extend the output produced?

[In the absence of Java's "Checked Exceptions"] I'd like, if possible,
to add into these documents information about what Exceptions can
be thrown by my code. That way, at least other Developers will have
half an idea of what my code might do to them.

TIA,
Phill W.

Exceptions
Click to expand...
Click to expand...
 
See Tom... you can't just throw out a teaser like that and not tell me what
it is. =)

So... what is it?

And whats so special?

-CJ
Tom Spink said:
Just you wait for Whidbey ;-)

--
Happy to help,
-- Tom Spink
([email protected])

"Go down with your server"

http://dotnetx.betasafe.com >> On The Mend

Please respond to the newsgroup,
so all can benefit


CJ Taylor said:
I just asked this same questoin yesterday. check out gotdotnet for the VB
Commenter. I started using it this morning, seems pretty decent so far, but
not quite as good as the C# commenter. Which I like more. =)


Phill. W said:
Whilst hammering away cutting VB.Net code, I'm hearing (mostly
from my C#-cutting colleagues) about XML documentation that
can be produced from our .Net projects. Now, I've only scratched
the surface about this (and already worked out that I need an add-in
to do this from VB.Net) I'd like to ask:

Is it possible to extend the output produced?

[In the absence of Java's "Checked Exceptions"] I'd like, if possible,
to add into these documents information about what Exceptions can
be thrown by my code. That way, at least other Developers will have
half an idea of what my code might do to them.

TIA,
Phill W.

Exceptions
Click to expand...
Click to expand...
Click to expand...
 
Whidbey? The next VS.NET, language enhancements for VB.NET include, Operator
Overloading (yey!) and XML Documentation.

I can't remember where I read this though.

--
Happy to help,
-- Tom Spink
([email protected])

"Go down with your server"

http://dotnetx.betasafe.com >> On The Mend

Please respond to the newsgroup,
so all can benefit


CJ Taylor said:
See Tom... you can't just throw out a teaser like that and not tell me what
it is. =)

So... what is it?

And whats so special?

-CJ
Tom Spink said:
Just you wait for Whidbey ;-)

--
Happy to help,
-- Tom Spink
([email protected])

"Go down with your server"

http://dotnetx.betasafe.com >> On The Mend

Please respond to the newsgroup,
so all can benefit
Click to expand...
the
VB
Commenter. I started using it this morning, seems pretty decent so
Click to expand...
far,
but
not quite as good as the C# commenter. Which I like more. =)


Whilst hammering away cutting VB.Net code, I'm hearing (mostly
from my C#-cutting colleagues) about XML documentation that
can be produced from our .Net projects. Now, I've only scratched
the surface about this (and already worked out that I need an add-in
to do this from VB.Net) I'd like to ask:

Is it possible to extend the output produced?

[In the absence of Java's "Checked Exceptions"] I'd like, if possible,
to add into these documents information about what Exceptions can
be thrown by my code. That way, at least other Developers will have
half an idea of what my code might do to them.

TIA,
Phill W.

Exceptions
Click to expand...
Click to expand...
Click to expand...
 
Whidbey? The next VS.NET, language enhancements for VB.NET include,
Operator
Overloading (yey!) and XML Documentation.
Click to expand...

Tom, stop telling lies to the locals; you forgot to take your pills again
didn't you?

:)

~
Jeremy
 
Herfried K. Wagner said:
Hello,



Edit & Continue for VB .NET, generics, ...
Click to expand...

Generics?! Dare I say... <Templates>? In VB? Are you MAD?!

:-)

I will seriously explode with happyness if they add Templates(or something
like it) to VB...

~
Jeremy
 
Hello,

Jeremy Cowles said:
Generics?! Dare I say... <Templates>? In VB? Are you MAD?!
Click to expand...

Yes. Generics ("templates" in C++ terminology). You can read that in the
article (I posted the link before).
:-)

I will seriously explode with happyness if they add Templates
(or something like it) to VB...
Click to expand...

I am very happy about that too...

:-)))

Regards,
Herfried K. Wagner
 
Jeremy,
I will seriously explode with happyness if they add Templates(or something
like it) to VB...
Click to expand...
I'm sure Armin & Herfried would join me in wanting to see the video of you
"exploding with happiness". :-)) (in a good way of course)

Yes: Generics are to .NET as Templates are to C++.

And according to the above mentioned documents we VB.NET gets them!

For details of how they will work see:
http://msdn.microsoft.com/msdnmag/issues/03/09/net/default.aspx

and:
http://msdn.microsoft.com/library/d...l/vbconCProgrammingLanguageFutureFeatures.asp

One of the articles I read I got the impression VB.NET will be both a
producer & consumer of generics...

Hope this helps
Jay
 
Jerermy
Umm...
it just that when you copy the code base for your
collections 100 times, and then you find a bug in one of them,
Click to expand...

Using inheritance you should not be copying base code.

Using CollectionBase or DictionaryBase there should be little code each
specific class needs.

Also there are generators out there that will generate the boiler plate code
that is unique to each collection. Its also not that hard to write your own
generator.

I hope I am taking you too literally! :-)

Jay
 
it just that when you copy the code base for your
Using inheritance you should not be copying base code.
Click to expand...

You can't inherit the Item property, or the Add sub, you see because they
require a specific type.

Using CollectionBase or DictionaryBase there should be little code each
specific class needs.
Click to expand...

I inherit from CollectionBase, but still, you must rewrite for the specific
types every time.

Also there are generators out there that will generate the boiler plate code
that is unique to each collection. Its also not that hard to write your own
generator.
Click to expand...

I have actually created macros for almost everything (notation, classes,
methods, properties, TSQL, stored procs, data conversion, you name it - I
love the macros! It's just like when i used to smoke PCP and code all
night!), and that does ease the pain, but it's the principle of the matter
that eerks me, you know? Maybe I am just a whiner.

:)

~
Jeremy
 
Back
Top