473,326 Members | 2,147 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,326 software developers and data experts.

XML comments questions

Q1: The intellisense summary info for a class only seems to update after a
change to that class's XML comments if I remove the reference to the project
from the current project and add it back again. Why so, and how do I stop
this?

Q2: The <seealso> tag seems to be required (by Vis. Stu. 2003 at least) to
be inside the <summary> tag. However in the intellisense the seealso data
gets tagged onto the end of the summary info as a (as far as the user is
concerned) random floating typename of method. How do I prevent this?

Clive
Nov 17 '05 #1
6 2149
Clive,

Q1: I've never noticed this. It is possible that it is being cached. If
you are referencing the project, I would think that it would update
automatically. However, if you are not referencing the project, but rather,
referencing the DLL, you will have to do a recompile of the XML file.

Q2: Are you sure that you are including the ending slash, something like:

<summary>See the documentation for <seealso cref="MyClass"/>.</summary>

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Clive Dixon" <cl*******************@digita.noluncheonmeat.com > wrote in
message news:ep**************@TK2MSFTNGP12.phx.gbl...
Q1: The intellisense summary info for a class only seems to update after a
change to that class's XML comments if I remove the reference to the
project from the current project and add it back again. Why so, and how do
I stop this?

Q2: The <seealso> tag seems to be required (by Vis. Stu. 2003 at least) to
be inside the <summary> tag. However in the intellisense the seealso data
gets tagged onto the end of the summary info as a (as far as the user is
concerned) random floating typename of method. How do I prevent this?

Clive

Nov 17 '05 #2
> Q1: The intellisense summary info for a class only seems to update after a
change to that class's XML comments if I remove the reference to the
project from the current project and add it back again. Why so, and how do
I stop this?
You need to configure your project to create the XML commenting when it
builds. This is done in the Project Properties dialog box.
Q2: The <seealso> tag seems to be required (by Vis. Stu. 2003 at least) to
be inside the <summary> tag. However in the intellisense the seealso data
gets tagged onto the end of the summary info as a (as far as the user is
concerned) random floating typename of method. How do I prevent this?
Good information here:

http://msdn2.microsoft.com/en-us/library/b2s063f7.aspx

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer
A watched clock never boils.

"Clive Dixon" <cl*******************@digita.noluncheonmeat.com > wrote in
message news:ep**************@TK2MSFTNGP12.phx.gbl... Q1: The intellisense summary info for a class only seems to update after a
change to that class's XML comments if I remove the reference to the
project from the current project and add it back again. Why so, and how do
I stop this?

Q2: The <seealso> tag seems to be required (by Vis. Stu. 2003 at least) to
be inside the <summary> tag. However in the intellisense the seealso data
gets tagged onto the end of the summary info as a (as far as the user is
concerned) random floating typename of method. How do I prevent this?

Clive

Nov 17 '05 #3
Kevin Spencer <ke***@DIESPAMMERSDIEtakempis.com> wrote:
Q1: The intellisense summary info for a class only seems to update after a
change to that class's XML comments if I remove the reference to the
project from the current project and add it back again. Why so, and how do
I stop this?


You need to configure your project to create the XML commenting when it
builds. This is done in the Project Properties dialog box.


I didn't think that affected things so long as the projects were all
within the same solution. Unfortunately, generating the XML
documentation for all builds often (for me, anyway) ends up requiring
restarts of VS.NET between builds, as it will lock the file which it
then needs to overwrite. I'm hoping VS 2005 is better on this score :)

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet Blog: http://www.msmvps.com/jon.skeet
If replying to the group, please do not mail me too
Nov 17 '05 #4
Hi Jon,

I should mention that I WAS talking about VS.Net 2005. My apologies if there
was any confusion. I keep forgetting that it is only now being released.
I've been working with it for about a year now.

VS.Net 2005 has no such issues with regards to building the comments on
compile. I am also much happier with the results. It does not generate HTML,
but XML Code Comment Reports. This is a much more flexible and extensible
format. In fact, I am currently working on an XSL transform to create our
own in-house software documentation library. Using XSL, I can organize the
documentation in any way I like, create cross-topic links, create a variety
of document types, and so on. The sort of things you can do with XSL. Kudos
to Microsoft on the new Comment model!

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer
A watched clock never boils.

"Jon Skeet [C# MVP]" <sk***@pobox.com> wrote in message
news:MP************************@msnews.microsoft.c om...
Kevin Spencer <ke***@DIESPAMMERSDIEtakempis.com> wrote:
> Q1: The intellisense summary info for a class only seems to update
> after a
> change to that class's XML comments if I remove the reference to the
> project from the current project and add it back again. Why so, and how
> do
> I stop this?


You need to configure your project to create the XML commenting when it
builds. This is done in the Project Properties dialog box.


I didn't think that affected things so long as the projects were all
within the same solution. Unfortunately, generating the XML
documentation for all builds often (for me, anyway) ends up requiring
restarts of VS.NET between builds, as it will lock the file which it
then needs to overwrite. I'm hoping VS 2005 is better on this score :)

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet Blog: http://www.msmvps.com/jon.skeet
If replying to the group, please do not mail me too

Nov 17 '05 #5
Kevin Spencer <ke***@DIESPAMMERSDIEtakempis.com> wrote:
I should mention that I WAS talking about VS.Net 2005. My apologies if there
was any confusion. I keep forgetting that it is only now being released.
I've been working with it for about a year now.

VS.Net 2005 has no such issues with regards to building the comments on
compile. I am also much happier with the results. It does not generate HTML,
but XML Code Comment Reports.
VS.NET 2003 does that already - although that's where the problems with
locking come in.
This is a much more flexible and extensible
format. In fact, I am currently working on an XSL transform to create our
own in-house software documentation library. Using XSL, I can organize the
documentation in any way I like, create cross-topic links, create a variety
of document types, and so on. The sort of things you can do with XSL. Kudos
to Microsoft on the new Comment model!


It's not new at all - it's been available for ages. You might want to
look at NDoc, which already builds docs in various different ways.

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet Blog: http://www.msmvps.com/jon.skeet
If replying to the group, please do not mail me too
Nov 17 '05 #6
Yeah, I've seen NDoc, but I won't learn anything by using it, so I'm rolling
my own. ;-)

--
HTH,

Kevin Spencer
Microsoft MVP
..Net Developer
A watched clock never boils.

"Jon Skeet [C# MVP]" <sk***@pobox.com> wrote in message
news:MP************************@msnews.microsoft.c om...
Kevin Spencer <ke***@DIESPAMMERSDIEtakempis.com> wrote:
I should mention that I WAS talking about VS.Net 2005. My apologies if
there
was any confusion. I keep forgetting that it is only now being released.
I've been working with it for about a year now.

VS.Net 2005 has no such issues with regards to building the comments on
compile. I am also much happier with the results. It does not generate
HTML,
but XML Code Comment Reports.


VS.NET 2003 does that already - although that's where the problems with
locking come in.
This is a much more flexible and extensible
format. In fact, I am currently working on an XSL transform to create our
own in-house software documentation library. Using XSL, I can organize
the
documentation in any way I like, create cross-topic links, create a
variety
of document types, and so on. The sort of things you can do with XSL.
Kudos
to Microsoft on the new Comment model!


It's not new at all - it's been available for ages. You might want to
look at NDoc, which already builds docs in various different ways.

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet Blog: http://www.msmvps.com/jon.skeet
If replying to the group, please do not mail me too

Nov 17 '05 #7

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

Similar topics

32
by: Elliot Temple | last post by:
Hi I have two questions. Could someone explain to me why Python is case sensitive? I find that annoying. Also, why aren't there multiline comments? Would adding them cause a problem of some...
5
by: Alex | last post by:
Hi all, We're looking at a vendor who uses the InterSystems Cache Database Platform, but our IT department has zero experience with this system. This software package will have a pivotal and...
7
by: pmatos | last post by:
Hi all, I've been having questions about strings, references, initializations... I've created code (which will not compile due to a reference problem) and I'd like comments on why this won't...
6
by: Geoff Cox | last post by:
Hello, I wonder if this is possible? I have some code which works but would appreciate comments with a view to improving the code - appropriate to post it and ask for comments? Cheers ...
10
by: Geoff Cox | last post by:
Hello, The Javascript code at the URL below does work but no doubt there are better ways of coding the app so would appreciate any comments! ...
2
by: Vivek Kumar | last post by:
Hi all, I have to write a network server (sort of) and I am looking for your valuable comments. Currently I have written a prototype in VB6 but it can only handle up to 30 or so clients. I need...
0
by: Michael.Suarez | last post by:
So we develop and maintain several applications used by several people in the same company, on the same intranet. There are several applications written in VB6, but going forward all of the new...
13
Savage
by: Savage | last post by:
Hi everyone, this is questions and comments thread about this article. If u have any comments or questions please post them here.. Savage
1
by: jerger | last post by:
I have not made a program or page from start yet. I have made modifications to our signoff asp pages like changing the questions, texts, shortening field lengths etc... I also have copied the files...
6
by: Marjeta | last post by:
I was trying to compare a particular trigger on multiple servers. First I tried phpMyAdmin to script the trigger code, which unfortunately only worked on one server that has newer version of...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

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.