Re: Wanted in C# 2.0: Namespace documentation
From: Colin Young (x_at_nospam.com)
Date: 05/19/04
- Next message: Nicholas Paldino [.NET/C# MVP]: "Re: C# equivalent of JTable?"
- Previous message: Rodrigo DeJuana: "Re: problem with WebControls.TextBox"
- In reply to: Jon Davis: "Wanted in C# 2.0: Namespace documentation"
- Next in thread: mikeb: "Re: Wanted in C# 2.0: Namespace documentation"
- Reply: mikeb: "Re: Wanted in C# 2.0: Namespace documentation"
- Reply: Jon Davis: "Re: Wanted in C# 2.0: Namespace documentation"
- Messages sorted by: [ date ] [ thread ]
Date: Wed, 19 May 2004 14:18:42 -0400
Actually, you can document namespaces already, but it needs to be done in an
external file IIRC. I don't remember if the MS tools can use it, or if you
need to use NDoc. If you do a bit of a search, you should be able to find
some information about it. Unfortunately the project where I used it was 2
computers ago and I don't seem to have put my build scripts and the
namespace documentation into source control.
If I find more info, I'll post it to this thread.
Colin
"Jon Davis" <jon@REMOVE.ME.jondavis.net> wrote in message
news:eg6o6iWPEHA.1348@TK2MSFTNGP12.phx.gbl...
> Namespaces don't have <summary> documentation (do they?), and I think it
> would be nice to have it. For instance,
>
> /// <summary>
> /// Classes containing math functions.
> /// </summary>
> namespace BillyBob.Math {
> ...
> }
>
> Now if you had more than one <summary> compiled with a namespace, such as
> having two class files each with a different <summary> for its otherwise
> identical namespace, then the consumer could be able to cycle through the
> different summary descriptions... it should be an array of descriptions.
>
> Might be a little messy I suppose, but it's better than no descriptions at
> all.
>
> Sometimes people deliver things in the strangest namespaces ...
>
> Jon
>
>
- Next message: Nicholas Paldino [.NET/C# MVP]: "Re: C# equivalent of JTable?"
- Previous message: Rodrigo DeJuana: "Re: problem with WebControls.TextBox"
- In reply to: Jon Davis: "Wanted in C# 2.0: Namespace documentation"
- Next in thread: mikeb: "Re: Wanted in C# 2.0: Namespace documentation"
- Reply: mikeb: "Re: Wanted in C# 2.0: Namespace documentation"
- Reply: Jon Davis: "Re: Wanted in C# 2.0: Namespace documentation"
- Messages sorted by: [ date ] [ thread ]
Relevant Pages
|
