I've been looking at the XML documentation for C# code. I've put in a
number of <summary>, <remarks>, <param> tags and used the /doc switch to
create an XML file.
What now?
I was expecting to have a style sheet or some other mechanism to present the
documentation. I was also expecting to have the summary and params show up
in IntelliSense.
Does anyone know where this is going? Is this one of those features that is
half implemented and I need to wait for VS2005?
Regards,
Bob Rundle 5  1442 
Bob, What now?
There's a "Build Comment Web Pages" command on the Tools menu that you
can use. You should also look at NDoc at http://ndoc.sourceforge.net
I was also expecting to have the summary and params show up
in IntelliSense.
That should work.
Does anyone know where this is going? Is this one of those features that is
half implemented and I need to wait for VS2005?
AFAIK the feature hasn't changed much in VS 2005.
Mattias
--
Mattias Sjögren [MVP] mattias @ mvps.org http://www.msjogren.net/dotnet/ | http://www.dotnetinterop.com
Please reply only to the newsgroup.
Bob Rundle <ru****@rundle. com> wrote: I've been looking at the XML documentation for C# code. I've put in a
number of <summary>, <remarks>, <param> tags and used the /doc switch to
create an XML file.
What now?
I was expecting to have a style sheet or some other mechanism to present the
documentation. I was also expecting to have the summary and params show up
in IntelliSense.
You can build documentation pages from it with NDoc
( http://ndoc.sf.net). If you give it the same name as your assembly
(but replacing .dll with .xml) and have it in the same directory as
your assembly, it will work with intellisense.
--
Jon Skeet - <sk***@pobox.co m> http://www.pobox.com/~skeet
If replying to the group, please do not mail me too
Jon
Thanks for the help. Indeed, as soon as I got the .xml file in the same
directory with the assembly, intellisense started working
I'm working with a group that wants to use Doxygen. However with the good
editor support for the XML Documentation in C#, I going to try to convince
them to use XML Documentation for the C# code.
It's a pity the XML Documentation only works for C#.
Regards,
Bob Rundle
"Jon Skeet [C# MVP]" <sk***@pobox.co m> wrote in message
news:MP******** *************** *@msnews.micros oft.com... Bob Rundle <ru****@rundle. com> wrote: I've been looking at the XML documentation for C# code. I've put in a
number of <summary>, <remarks>, <param> tags and used the /doc switch to
create an XML file.
What now?
I was expecting to have a style sheet or some other mechanism to present
the documentation. I was also expecting to have the summary and params show
up in IntelliSense.
You can build documentation pages from it with NDoc
(http://ndoc.sf.net). If you give it the same name as your assembly
(but replacing .dll with .xml) and have it in the same directory as
your assembly, it will work with intellisense.
--
Jon Skeet - <sk***@pobox.co m>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too
Thanks. The "Build Comment Web Pages" was the missing piece.
"Mattias Sjögren" <ma************ ********@mvps.o rg> wrote in message
news:%2******** ********@TK2MSF TNGP11.phx.gbl. .. Bob,
What now?
There's a "Build Comment Web Pages" command on the Tools menu that you
can use. You should also look at NDoc at http://ndoc.sourceforge.net
I was also expecting to have the summary and params show up
in IntelliSense.
That should work.
Does anyone know where this is going? Is this one of those features that
ishalf implemented and I need to wait for VS2005?
AFAIK the feature hasn't changed much in VS 2005.
Mattias
--
Mattias Sjögren [MVP] mattias @ mvps.org
http://www.msjogren.net/dotnet/ | http://www.dotnetinterop.com
Please reply only to the newsgroup.
It's a pity the XML Documentation only works for C#.
Now, VS2005 should help with that, ;).
As for XML comments in vb, there are some third party tools(and maybe an
unsupported ms one, I forget) to add it to vb. Just google for them. This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics | |
by: Daniel Ehrenberg |
last post by:
I'm trying to learn wxPython, but I can't seem to find much
documentation. The wxPython website says that all advanced (and even
some basic) documentation for wxPython is only available in C++ syntax
in the main wxWindows documentation. It also says that the samples
will help, but I can't seem to make sense of them. Should I just use a
not-as-good GUI like Tkinter or a not-as-common one like Anygui or
PyUI if I want to have documentation?...
|
by: Fredrik Olsson |
last post by:
Hello.
For Java there is javadac, for Obj-C headerdoc2html, for C doxygen, and even
for good old VB 6 there is VBDox.
But I have found no suitable tool for documenting my .net code to get
documentation that is consistent with what MSDN offers and .net-develoepers
are used to.
I guess I have only searched int he wrong places, or with the wrong keywords
|
by: Cameron Laird |
last post by:
QOTW: "Python makes it easy to implement algorithms." - casevh
"Most of the discussion of immutables here seems to be caused by
newcomers wanting to copy an idiom from another language which doesn't
have immutable variables. Their real problem is usually with binding,
not immutability." - Mike Meyer
Among the treasures available in The Wiki is the current
copy of "the Sorting min-howto":
|
by: sh |
last post by:
I'm relatively new to VB.NET, although I've been a VB programmer for
over 10 years. I'm looking for a controls suite (something like
Infragistics or ComponentOne). However, I've been burned before with
products that have poor documentation and I don't want to get burned again.
I'm not looking for a suite who's main feature is whiz-bang aesthetics.
I'm looking for increased functionality, but I don't want to spend hours
on end getting it...
|
by: nicolasfr |
last post by:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
That's why I have started a collaborative project to make a user
contributed Python documentation. The wiki is online here:
http://www.pythondocs.info
| | |
by: kbutterly |
last post by:
Good morning all,
I have a weird problem with my VS 2005 Documentation. When I open the
help file through Start -Visual Studion 2005 ->Visual Studio 2005
Documentation, I get what appears to be the VS 2005 help. The title
bar shows 'Search - Microsoft Visual Studio 2005 Documentation -
Microsoft Document Explorer'
However, if I select either Contents or Index, and click on the
Filtered by drop-down, every item listed is SQL Server...
|
by: Smokey Grindle |
last post by:
We are trying to find a system that would be good for a development team to
share documentation on our .net solutions throughout our company. Does
anyone know of any systems out there that are good for handleing information
such as lists of what's changed, whats being worked on, what documentation
was recently changed, and a way to browse documentation like a book maybe?
Im not talking about the inline documentation comments in the souce of...
|
by: Eric Sadoyama |
last post by:
I have a database documentation question, but I am not even sure how
to phrase it properly so I don't know where to start looking for
answers.
We are developing a database that is based on several different data
standards and schema. I'm finding it confusing to keep it all
straight. What's this field for? Which standards document is it based
on? What are the permitted values? Which business rule governs it?
In theory, we do have all...
|
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, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look !
Part I. Meaning of...
|
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed.
This is as boiled down as I can make it.
Here is my compilation command:
g++-12 -std=c++20 -Wnarrowing bit_field.cpp
Here is the code in...
|
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 tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth.
The Art of Business Website Design
Your website is...
| | |
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 Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
|
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, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own....
Now, this would greatly impact the work of software developers. The idea...
|
by: isladogs |
last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 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 a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules.
He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms.
Adolph will...
|
by: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one.
At the time of converting from word file to html my equations which are in the word document file was convert into image.
Globals.ThisAddIn.Application.ActiveDocument.Select();...
|
by: 6302768590 |
last post by:
Hai team
i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
|
by: bsmnconsultancy |
last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...
| |
