Schema for C# XML Documentation

Daniel Cazzulino

unread,

Aug 21, 2002, 2:58:26 PM8/21/02

to

Hi all!
I wanted to know if there is an XML Schema for C# XML documentation, so I
don't start writing my own.
I'd like it in order to validate a documentation file and add some custom
constraints such as naming conventions, required elements, etc.

Thanks!

--
Daniel Cazzulino
CTO - DEVerest
Tel +54 11 4247 7396
www.deverest.com.ar
dotnetopensrc.sourceforge.net

"Better to understand a little than to misunderstand a lot."

Dare Obasanjo

unread,

Aug 22, 2002, 12:16:48 PM8/22/02

to

"Daniel Cazzulino" <kazz...@hotmail.com> wrote in message
news:OXx4HTUSCHA.2024@tkmsftngp08...

> Hi all!
> I wanted to know if there is an XML Schema for C# XML documentation, so I
> don't start writing my own.

There isn't one to my knowledge.

--
This posting is provided "AS IS" with no warranties, and confers no rights.

Joe Feser

unread,

Aug 22, 2002, 2:37:13 PM8/22/02

to

I started one,

Contact me if you want we can finish it together.

Joe

"Daniel Cazzulino" <kazz...@hotmail.com> wrote in message
news:OXx4HTUSCHA.2024@tkmsftngp08...

Daniel Cazzulino

unread,

Aug 22, 2002, 3:48:19 PM8/22/02

to

Ops... I already finished it :o) See my other post... the file is attached.

--
Daniel Cazzulino
CTO - DEVerest
Tel +54 11 4247 7396
www.deverest.com.ar
dotnetopensrc.sourceforge.net

"Better to understand a little than to misunderstand a lot."

"Joe Feser" <nn...@fesersoft.com> wrote in message
news:uJ3ULrgSCHA.3968@tkmsftngp12...

Chris Lovett

unread,

Aug 22, 2002, 8:13:13 PM8/22/02

to

There is no fixed schema because the C# compiler allows
anything to go there. The following lists the special
tags that the C# compiler does verify.

See http://msdn.microsoft.com/library/en-
us/csref/html/vclrfTagsForDocumentationComments.asp

>-----Original Message-----
>I created it myself. There are many undocumented tags
in mscorlib.xml, for
>example. I added them to the schema.
>If you want to enforce certain documentation style for
your projects, you
>can rely on XML Schema validation, make some elements
required, add
>attributes, new elements, etc. You can use one this as
the starting point.
>
>HTH

>
>--
>Daniel Cazzulino
>CTO - DEVerest
>Tel +54 11 4247 7396
>www.deverest.com.ar
>dotnetopensrc.sourceforge.net
>
>"Better to understand a little than to misunderstand a
lot."
>

>"Daniel Cazzulino" <kazz...@hotmail.com> wrote in
message
>news:OXx4HTUSCHA.2024@tkmsftngp08...

Daniel Cazzulino

unread,

Aug 22, 2002, 11:47:37 PM8/22/02

to

> There is no fixed schema because the C# compiler allows
> anything to go there.

Sure, but it would have been nice to have a base schema to start with, and
include it in our own custom schema, to enforce special documentation
project-wide.
I can do it now :o)

--
Daniel Cazzulino
CTO - DEVerest
Tel +54 11 4247 7396
www.deverest.com.ar
dotnetopensrc.sourceforge.net

"Better to understand a little than to misunderstand a lot."

"Chris Lovett" <nos...@please.com> wrote in message
news:787e01c24a39$df0df3a0$a4e62ecf@tkmsftngxa06...

Daniel Cazzulino

unread,

Aug 23, 2002, 12:16:22 AM8/23/02

to

And I'm not worried about a schema for compilation, but for post-compilation
validation ;)

Cheers,
Daniel

"Daniel Cazzulino" <kazz...@hotmail.com> wrote in message

news:#sKvxelSCHA.2336@tkmsftngp08...