473,320 Members | 1,902 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,320 software developers and data experts.

How to add an xml fragment into C# Documentation Comments

ano
Hi all,

I try to add an XML fragment into C# Documentation Comments like this:

/// <example>
///<code>
///<book>
/// <name>Book1</name>
///</book>
///</code>
///</example>

but it's work because the xml tags are not appear.

Anyone know how to do this?

Thanks,
ano
Aug 15 '06 #1
3 2750
What are u doing?

Why do u need the XML tag? it's only preprocessor directive

--
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


"ano" wrote:
Hi all,

I try to add an XML fragment into C# Documentation Comments like this:

/// <example>
///<code>
///<book>
/// <name>Book1</name>
///</book>
///</code>
///</example>

but it's work because the xml tags are not appear.

Anyone know how to do this?

Thanks,
ano
Aug 15 '06 #2
ano
Just to provide an example to the help file, like this
http://msdn.microsoft.com/library/de...electtopic.asp

I just want to know, how to put "<" after /// because when I put an example
code like this

/// List<...>

I got a comment error.

thanks,
ano

"Michael Nemtsev" wrote:
What are u doing?

Why do u need the XML tag? it's only preprocessor directive

--
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


"ano" wrote:
Hi all,

I try to add an XML fragment into C# Documentation Comments like this:

/// <example>
///<code>
///<book>
/// <name>Book1</name>
///</book>
///</code>
///</example>

but it's work because the xml tags are not appear.

Anyone know how to do this?

Thanks,
ano
Aug 15 '06 #3
ano,

Why not use a CDATA section in the documentation? It should allow you
to put an XML fragment in that.

Also, if you want to make a reference to the List<Tclass, it should be
within a <seeXML comment. There is a specific way to reference generic
types in XML comments. The documentation for the <seetag has examples
that show you how to do it:

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

Hope this helps.

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

"ano" <an*@discussions.microsoft.comwrote in message
news:C2**********************************@microsof t.com...
Just to provide an example to the help file, like this
http://msdn.microsoft.com/library/de...electtopic.asp

I just want to know, how to put "<" after /// because when I put an
example
code like this

/// List<...>

I got a comment error.

thanks,
ano

"Michael Nemtsev" wrote:
>What are u doing?

Why do u need the XML tag? it's only preprocessor directive

--
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


"ano" wrote:
Hi all,

I try to add an XML fragment into C# Documentation Comments like this:

/// <example>
///<code>
///<book>
/// <name>Book1</name>
///</book>
///</code>
///</example>

but it's work because the xml tags are not appear.

Anyone know how to do this?

Thanks,
ano

Aug 15 '06 #4

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

Similar topics

17
by: Bart Nessux | last post by:
How can one view the contents of a queue? I'd like to verify that the queue has the same number of objects as the list that has been put into it. Also, should one think of a queue as static or...
8
by: Guyon Morée | last post by:
hi, I've been working with PHP lately and what I found is that the docs are awesome, as is the python are python docs btw. but one thing that I really like about theirs is the doc-commenting system...
14
by: Don Wash | last post by:
Hi There! In C# you can use /// to add comments that can produce XML documentation. What about in VB???? Thanks, Don
5
by: WStoreyII | last post by:
Is there some sort of a preset way for compiling documetation about an assembly or a project. The Reason that i ask this is that sometimes when i look at examples for code i see things like this....
40
by: GTi | last post by:
Is there any source code documentation tools available for Visual Studio 2005 ? I have created a LIB that must be documented. Must I do it by hand or is it some kind of tools to pre document my...
5
by: Bob Altman | last post by:
I thought I read somewhere in the MS documentation that XML documentation is compiled in C++, but the C++ code editor obviously doesn't do anything interesting when I enter "///". What's the deal...
2
by: Shimon Sim | last post by:
Hi I keep getting error : WriteStartDocument cannot be called on writers created with ConformanceLevel.Fragment. The code that I have is very simple. SimpleClass c = new SimpleClass();
0
by: DolphinDB | last post by:
The formulas of 101 quantitative trading alphas used by WorldQuant were presented in the paper 101 Formulaic Alphas. However, some formulas are complex, leading to challenges in calculation. Take...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
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: 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...
0
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
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

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.