Re: Source code documentation

Tech-Archive recommends: Repair Windows Errors & Optimize Windows Performance

I can see your point. I don't know why they left it out. I do know that when
I created by XSLT, doing Generics was a bit tricky. Perhaps they didn't have
the time, and it will be available in the future as a downloadable add-on.

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer

Presuming that God is "only an idea" -
Ideas exist.
Therefore, God exists.

"rmacias" <rmacias@xxxxxxxxxxxxxxxx> wrote in message
news:3559CD46-F6EC-405B-B93B-1EC038E3AD2F@xxxxxxxxxxxxxxxx
I don't think you understood what I said. That is not what I found
disappointing.

In VS 2003, you could use the inline XML Comments to document your code in
the source code files. The compiler would read these XML comments and
generate an XML document with this information. Now VS 2003 had a built
in
tool to read this XML Document, and generate an MSDN like web page that
has
your code documented.

The idea was, "We have a tool to interpret the XML document and display it
in a web page to document your code. If it does not suit your needs, then
use NDoc or write your own tool (XSLT, etc) to suit your needs."

Now, in VS 2005, the compiler still generates the XML Document and that's
it. Now the idea is "Here's the XML document, now write your own tool to
do
as you wish. We will no longer give you a tool do generate a page for
you.
You have to do it yourself." And now as an other user stated, NDoc does
not
fully support .NET 2.0 XML code genreated comments (I'll have to look into
this to see if this is true).

What I found disappointint is that they took a tool away that reads the
XML
Comment document for you. Most of the time, it suited my needs

"Kevin Spencer" wrote:

Are you saying the option in VS2003 Tools->Build Comment Web Pages has
been
taken out is VS2005? Wow, I did not know that.....pretty
disappointing.

It's not really disappointing if you think about it. If you create HTML
Code
Comments, you have created an HTML document. Modifying it to suit your
own
model of how it should look is a pain in the butt. HTML is simply *not*
extensible.

But if you create XML Code Comments, you can create *any* type of
document
from the XML, simply by creating an XSL Transform for it. You can
transform
it in any way you like, and change the format with a simple change to the
XSLT that you use to format it. That is what I did in the page I
mentioned
earlier in the thread. I created my own XSLT and use it for all of our
in-house code documentation.

This is part of the "new direction" that Microsoft has been taking, and I
welcome it!

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer

Presuming that God is "only an idea" -
Ideas exist.
Therefore, God exists.


"rmacias" <rmacias@xxxxxxxxxxxxxxxx> wrote in message
news:3568CEFD-E30A-4272-90E0-9F94C9C00F58@xxxxxxxxxxxxxxxx
Are you saying the option in VS2003 Tools->Build Comment Web Pages has
been
taken out is VS2005? Wow, I did not know that.....pretty
disappointing.

"Michael Nemtsev" wrote:

Hello Christoph,

Kevin means that you can get XML documentation, not the chm compiled
as
NDoc
did.
To turn this on go to the project properties->Build panel-> check "XML
Documentation
file"

to be shure that every method/class has been documented check "treat
warnings
as error" on ALL

CN> On Sat, 4 Mar 2006 10:25:52 -0500, "Kevin Spencer"
CN> <kevin@xxxxxxxxxxxxxxxxxxxxxxxxxx> wrote:
CN>
There is built-in XML Documentation Comment support in Visual
Studio.Net 2005.

CN> There is!? Where? I was firmly convinced that this 2003 feature
was
CN> taken out of 2005 -- can you tell me the exact menu location?
CN>
---
WBR,
Michael Nemtsev :: blog: http://spaces.msn.com/laflour

"At times one remains faithful to a cause only because its opponents
do
not
cease to be insipid." (c) Friedrich Nietzsche








.

Relevant Pages

  • Re: XML Transform
    ... I dont pass the XSLT as a parameter to the C# beacause they are store in the ... same database. ... I have a table that has the XSLT and the information level (we ... we have 3 XSLT that we apply to the XML Document received). ...
    (microsoft.public.sqlserver.xml)
  • Re: XML Transform
    ... same database. ... I have a table that has the XSLT and the information level ... we have 3 XSLT that we apply to the XML Document received). ... Is SQL Server ...
    (microsoft.public.sqlserver.xml)
  • Re: Newbie question about how to solve the use escape characters
    ... > Hi, I am a newbie, I spend quite sometime searching on the web, but I ... > I am trying to convert XML document into another form, ... A more useful form would be ... The following XSLT will do this. ...
    (comp.text.xml)
  • Re: Find and Replace within an XML file
    ... Several languages will do this, notably XSLT, although XSLT 1.0 isn't very good at string manipulation. ... that would mean knownig all the HTML codes for characters. ... have a robust model for avoiding trespassing on the markup, it will be faster to use a stream editor than to write it in a language which needs to invoke a formal parse of the XML document first. ...
    (microsoft.public.dotnet.xml)
  • Re: Source code documentation
    ... I agree with you rmacias, the tool provided in 2003 was more than adequate ... people are expected to rely on group projects such as NDoc which seems to be ... generate an XML document with this information. ... I did not know that.....pretty disappointing. ...
    (microsoft.public.dotnet.languages.csharp)