I have a Windows program C# .NET solution where when I update its XML
documentation, some tags are not recognized and turned into the
corresponding HTML. Those tags include <c>, <code>, <para>, <paramref>, and
<exception>. <remarks> works; I have not tried <include>. Is this a bug in
Studio or am I using those tags incorrectly?
When the tag appears to have an attribute, I have tried
<paramref="parameter">paramter name</paramref> and the way that autocomplete
completes the tag: <paramref=">parameter"/>. Since neither works, which is
correct? What, if anything, am I doing wrong?
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb ( www.qurb.com) 8  1960 
Will Pittenger wrote: I have a Windows program C# .NET solution where when I update its XML
documentation, some tags are not recognized and turned into the
corresponding HTML. Those tags include <c>, <code>, <para>,
<paramref>, and <exception>. <remarks> works; I have not tried
<include>. Is this a bug in Studio or am I using those tags
incorrectly?
When the tag appears to have an attribute, I have tried
<paramref="parameter">paramter name</paramref> and the way that
autocomplete completes the tag: <paramref=">parameter"/>. Since
neither works, which is correct? What, if anything, am I doing wrong?
Other than using the wrong tool... nothing ;-)
It's sorry that this particular feature of VS .NET is rather useless,
because it just does not support all the tags (for whatever reason). Switch
to NDoc, which is free and vastly superior: http://ndoc.sourceforge.net/wiki
Cheers,
--
Joerg Jooss jo*********@gmx.net
So, why doesn't Microsoft's documentation match what Microsoft actually
supports? Does this other package use the same tags and work from within
VS?
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb ( www.qurb.com)
"Joerg Jooss" <jo*********@gmx.net> wrote in message
news:Om**************@TK2MSFTNGP11.phx.gbl... Will Pittenger wrote: I have a Windows program C# .NET solution where when I update its XML
documentation, some tags are not recognized and turned into the
corresponding HTML. Those tags include <c>, <code>, <para>,
<paramref>, and <exception>. <remarks> works; I have not tried
<include>. Is this a bug in Studio or am I using those tags
incorrectly?
When the tag appears to have an attribute, I have tried
<paramref="parameter">paramter name</paramref> and the way that
autocomplete completes the tag: <paramref=">parameter"/>. Since
neither works, which is correct? What, if anything, am I doing wrong?
Other than using the wrong tool... nothing ;-)
It's sorry that this particular feature of VS .NET is rather useless,
because it just does not support all the tags (for whatever reason).
Switch to NDoc, which is free and vastly superior:
http://ndoc.sourceforge.net/wiki
Cheers,
--
Joerg Jooss
jo*********@gmx.net
NDoc iks not integrated with VS (to my knowledge) but it does support the
tags that Microsoft defined (<c>, <para>, <list> etc)
You can create an NDoc project file (*.ndoc), and then add that file to your
visual studio solution. If you then tell VS to associate that NDoc project
file with the NDoc executable, you can just double click the ndoc file in VS
and it will open NDoc for you. Hit the "build" button in ndoc and it will
build help for you - only one more step than what you currently are doing.
The resulting help files can be integrated with visual studio: http://www.reflectionit.nl/NDoc.aspx
As for why MS doesn't support their own documentation, my guess is
resources. I suppose that they had big plans but didn't have the time to
make it all happen (but at least they got the important part of the xml
comments and defining set syntax). NDoc came along and made it happen, so
there isn't as much reason for MS to reinvent the wheel (not that they
haven't done that before).
--
Mike Mayer, C# MVP mi**@mag37.com http://www.mag37.com/csharp/
"Will Pittenger" <wi************@verizon.net> wrote in message
news:u2**************@tk2msftngp13.phx.gbl... So, why doesn't Microsoft's documentation match what Microsoft actually
supports? Does this other package use the same tags and work from within
VS?
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb (www.qurb.com)
"Joerg Jooss" <jo*********@gmx.net> wrote in message
news:Om**************@TK2MSFTNGP11.phx.gbl... Will Pittenger wrote: I have a Windows program C# .NET solution where when I update its XML
documentation, some tags are not recognized and turned into the
corresponding HTML. Those tags include <c>, <code>, <para>,
<paramref>, and <exception>. <remarks> works; I have not tried
<include>. Is this a bug in Studio or am I using those tags
incorrectly?
When the tag appears to have an attribute, I have tried
<paramref="parameter">paramter name</paramref> and the way that
autocomplete completes the tag: <paramref=">parameter"/>. Since
neither works, which is correct? What, if anything, am I doing wrong?
Other than using the wrong tool... nothing ;-)
It's sorry that this particular feature of VS .NET is rather useless,
because it just does not support all the tags (for whatever reason).
Switch to NDoc, which is free and vastly superior:
http://ndoc.sourceforge.net/wiki
Cheers,
--
Joerg Jooss
jo*********@gmx.net
Well, I have suspected for several years that Microsoft always has a
"super-duper" build system that they keep to themselves. Everything works
and is better thought out. They certainly put their favorite goodies into
their own products before making them available in MFC, Win32, or .NET. As
an example, notice that Office does not follow your XP skin (or WindowBlinds
skin for that matter). You can get the look offered by the toolbar buttons
for buttons, button-style checkboxes, and button-style radio buttons, but
not in the .NET or MFC toolbars. In order to get AutoComplete to see new
classes and/or new members of classes, I commonly have to restart VS.
Microsoft's not supporting those tags may be more of the same. They
probably even claim they are helping 3rd party add-in developers out.
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb ( www.qurb.com)
"Michael Mayer [C# MVP]" <mi**@mag37.com> wrote in message
news:eR**************@TK2MSFTNGP10.phx.gbl... NDoc iks not integrated with VS (to my knowledge) but it does support the
tags that Microsoft defined (<c>, <para>, <list> etc)
You can create an NDoc project file (*.ndoc), and then add that file to
your visual studio solution. If you then tell VS to associate that NDoc project
file with the NDoc executable, you can just double click the ndoc file in
VS and it will open NDoc for you. Hit the "build" button in ndoc and it will
build help for you - only one more step than what you currently are doing.
The resulting help files can be integrated with visual studio:
http://www.reflectionit.nl/NDoc.aspx
As for why MS doesn't support their own documentation, my guess is
resources. I suppose that they had big plans but didn't have the time to
make it all happen (but at least they got the important part of the xml
comments and defining set syntax). NDoc came along and made it happen, so
there isn't as much reason for MS to reinvent the wheel (not that they
haven't done that before).
--
Mike Mayer, C# MVP
mi**@mag37.com
http://www.mag37.com/csharp/
"Will Pittenger" <wi************@verizon.net> wrote in message
news:u2**************@tk2msftngp13.phx.gbl... So, why doesn't Microsoft's documentation match what Microsoft actually
supports? Does this other package use the same tags and work from
within VS?
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb (www.qurb.com)
"Joerg Jooss" <jo*********@gmx.net> wrote in message
news:Om**************@TK2MSFTNGP11.phx.gbl... Will Pittenger wrote:
> I have a Windows program C# .NET solution where when I update its
XML > documentation, some tags are not recognized and turned into the
> corresponding HTML. Those tags include <c>, <code>, <para>,
> <paramref>, and <exception>. <remarks> works; I have not tried
> <include>. Is this a bug in Studio or am I using those tags
> incorrectly?
>
> When the tag appears to have an attribute, I have tried
> <paramref="parameter">paramter name</paramref> and the way that
> autocomplete completes the tag: <paramref=">parameter"/>. Since
> neither works, which is correct? What, if anything, am I doing
wrong?
Other than using the wrong tool... nothing ;-)
It's sorry that this particular feature of VS .NET is rather useless,
because it just does not support all the tags (for whatever reason).
Switch to NDoc, which is free and vastly superior:
http://ndoc.sourceforge.net/wiki
Cheers,
--
Joerg Jooss
jo*********@gmx.net
I was just looking at NDoc's website. From what I can tell, I might have to
build their project to install it. Second, in order to see updated
documentation, you must be able to build with no errors. Third,
IntelliSense does not help with the NDoc extensions to the tags. Fourth,
some hand coding of XML is required. (I have never worked directly with
XML.)
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb ( www.qurb.com)
"Michael Mayer [C# MVP]" <mi**@mag37.com> wrote in message
news:eR**************@TK2MSFTNGP10.phx.gbl... NDoc iks not integrated with VS (to my knowledge) but it does support the
tags that Microsoft defined (<c>, <para>, <list> etc)
You can create an NDoc project file (*.ndoc), and then add that file to
your visual studio solution. If you then tell VS to associate that NDoc project
file with the NDoc executable, you can just double click the ndoc file in
VS and it will open NDoc for you. Hit the "build" button in ndoc and it will
build help for you - only one more step than what you currently are doing.
The resulting help files can be integrated with visual studio:
http://www.reflectionit.nl/NDoc.aspx
As for why MS doesn't support their own documentation, my guess is
resources. I suppose that they had big plans but didn't have the time to
make it all happen (but at least they got the important part of the xml
comments and defining set syntax). NDoc came along and made it happen, so
there isn't as much reason for MS to reinvent the wheel (not that they
haven't done that before).
--
Mike Mayer, C# MVP
mi**@mag37.com
http://www.mag37.com/csharp/
"Will Pittenger" <wi************@verizon.net> wrote in message
news:u2**************@tk2msftngp13.phx.gbl... So, why doesn't Microsoft's documentation match what Microsoft actually
supports? Does this other package use the same tags and work from
within VS?
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb (www.qurb.com)
"Joerg Jooss" <jo*********@gmx.net> wrote in message
news:Om**************@TK2MSFTNGP11.phx.gbl... Will Pittenger wrote:
> I have a Windows program C# .NET solution where when I update its
XML > documentation, some tags are not recognized and turned into the
> corresponding HTML. Those tags include <c>, <code>, <para>,
> <paramref>, and <exception>. <remarks> works; I have not tried
> <include>. Is this a bug in Studio or am I using those tags
> incorrectly?
>
> When the tag appears to have an attribute, I have tried
> <paramref="parameter">paramter name</paramref> and the way that
> autocomplete completes the tag: <paramref=">parameter"/>. Since
> neither works, which is correct? What, if anything, am I doing
wrong?
Other than using the wrong tool... nothing ;-)
It's sorry that this particular feature of VS .NET is rather useless,
because it just does not support all the tags (for whatever reason).
Switch to NDoc, which is free and vastly superior:
http://ndoc.sourceforge.net/wiki
Cheers,
--
Joerg Jooss
jo*********@gmx.net
Will Pittenger wrote: I was just looking at NDoc's website. From what I can tell, I might
have to build their project to install it.
Come on, you're a developer ;-)
But there's no need to do that. Go to the project's page on SourceForge and
download a stable package (ndoc-devel-v1.2.zip):
http://sourceforge.net/project/showf...group_id=36057
If you want t create .chm help files, you will also need to install MS HTML
Workshop, which can be downloaded from MSDN or should be coming with your
version of VS .NET.
Second, in order to see
updated documentation, you must be able to build with no errors.
I'm not sure whether this an NDoc limitation -- the C# compiler produces all
necessary output for document generation.
Third, IntelliSense does not help with the NDoc extensions to the
tags.
Correct, but nothing forces you to use them.
Fourth, some hand coding of XML is required. (I have never
worked directly with XML.)
Well, you do work with C# XML comments already, don't you? Anyway, for basic
documentation generation, NDoc should work out-of-the-box if you stick to
the original comment tags you already know.
Cheers,
--
Joerg Jooss jo*********@gmx.net
With Microsoft's documenter, you can update the documentation from the Tools
menu without building.
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb ( www.qurb.com)
"Joerg Jooss" <jo*********@gmx.net> wrote in message
news:OY**************@tk2msftngp13.phx.gbl... Will Pittenger wrote: I was just looking at NDoc's website. From what I can tell, I might
have to build their project to install it.
Come on, you're a developer ;-)
But there's no need to do that. Go to the project's page on SourceForge
and download a stable package (ndoc-devel-v1.2.zip):
http://sourceforge.net/project/showf...group_id=36057
If you want t create .chm help files, you will also need to install MS
HTML Workshop, which can be downloaded from MSDN or should be coming with your
version of VS .NET.
Second, in order to see
updated documentation, you must be able to build with no errors.
I'm not sure whether this an NDoc limitation -- the C# compiler produces
all necessary output for document generation.
Third, IntelliSense does not help with the NDoc extensions to the
tags.
Correct, but nothing forces you to use them.
Fourth, some hand coding of XML is required. (I have never
worked directly with XML.)
Well, you do work with C# XML comments already, don't you? Anyway, for
basic documentation generation, NDoc should work out-of-the-box if you stick to
the original comment tags you already know.
Cheers,
--
Joerg Jooss
jo*********@gmx.net
Have you posted projects with NDoc specific tags to CodeProject? While
other users might not have a problem with the compiled project, they may be
unable to build the help system. I did want to post my project when I am
done.
----------
Will Pittenger
E-Mail: mailto:wi************@verizon.net
All mail filtered by Qurb ( www.qurb.com)
"Joerg Jooss" <jo*********@gmx.net> wrote in message
news:OY**************@tk2msftngp13.phx.gbl... Will Pittenger wrote: I was just looking at NDoc's website. From what I can tell, I might
have to build their project to install it.
Come on, you're a developer ;-)
But there's no need to do that. Go to the project's page on SourceForge
and download a stable package (ndoc-devel-v1.2.zip):
http://sourceforge.net/project/showf...group_id=36057
If you want t create .chm help files, you will also need to install MS
HTML Workshop, which can be downloaded from MSDN or should be coming with your
version of VS .NET.
Second, in order to see
updated documentation, you must be able to build with no errors.
I'm not sure whether this an NDoc limitation -- the C# compiler produces
all necessary output for document generation.
Third, IntelliSense does not help with the NDoc extensions to the
tags.
Correct, but nothing forces you to use them.
Fourth, some hand coding of XML is required. (I have never
worked directly with XML.)
Well, you do work with C# XML comments already, don't you? Anyway, for
basic documentation generation, NDoc should work out-of-the-box if you stick to
the original comment tags you already know.
Cheers,
--
Joerg Jooss
jo*********@gmx.net This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics
by: C Williams |
last post by:
Hi,
In a nutshell, my question is: how do i make a dll that I compile from
vb.net code register and work like one compiled as an ActiveX dll in VB6?
The IDE of my copy of visual basic.net does...
|
by: Will Pittenger |
last post by:
I have a Windows program C# .NET solution where when I update its XML
documentation, some tags are not recognized and turned into the
corresponding HTML. Those tags include <c>, <code>, <para>,...
|
by: John Mark Howell |
last post by:
BlankDoes anyone know what all HTML tags are allowed in the XML doc tags? Example, I know by experience that <h1> tags are allowed. What other tags are allowed? The MSDN is not clear about this.
...
|
by: Lasse Vågsæther Karlsen |
last post by:
I've been using XML Documentation in my class libraries since I
discovered this, and I have been using NDoc to produce help files from
the xml files so that the documentation is available outside...
|
by: Spike |
last post by:
I purchased Visual Basic .NET Deluxe Learning edition,
version 2003.
When I got to step 3 of the installation, the installer
couldn't find the help files on any of the included discs,
and so...
|
by: Jim |
last post by:
I am trying to write an HTTP/HTTPS proxy server in VB.Net 2005.
But, I don't really even know how the internal workings of a proxy should
act. Does anyone have anything on the protocols used in...
|
by: dba123 |
last post by:
Why am I getting this error for Budget?
Error: An exception of type 'System.FormatException' occurred in
mscorlib.dll but was not handled in user code
Additional information: String was not...
|
by: Lloyd Dupont |
last post by:
Let say I have 2 methods:
void BeginGroup();
void BeginGroup(string msg);
when I want to refer to them I write
/// <see cref="BeginGroup"/>
But this cause a compiler warning, where my...
|
by: emmanuelkatto |
last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud.
Please let me know.
Thanks!
Emmanuel
|
by: BarryA |
last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
|
by: nemocccc |
last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
|
by: Sonnysonu |
last post by:
This is the data of csv file
1 2 3
1 2 3
1 2 3
1 2 3
2 3
2 3
3
the lengths should be different i have to store the data by column-wise with in the specific length.
suppose the i have to...
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
|
by: Oralloy |
last post by:
Hello folks,
I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>".
The problem is that using the GNU compilers,...
|
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
|
by: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
|
by: agi2029 |
last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
| |
