Wanted in C# 2.0: Namespace documentation

Tech Tip: Click here to run a free scan for Windows Errors and optimize PC performance

From: Jon Davis (jon_at_REMOVE.ME.jondavis.net)
Date: 05/19/04 

Date: Tue, 18 May 2004 23:16:09 -0700

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

Relevant Pages

  • Memory Mapping Anomaly
    ... This is more of an anomaly in the MSDN documentation than any code. ... named mapping object in the Global namespace. ... I cannot see any documented way for applications to create named non-file ... backed sections that can be shared with applications in OTHER Sessions, ...
    (microsoft.public.win32.programmer.kernel)
  • Re: Ending Office Processes in VB .Net
    ... I think it in the System.Diagnostics namespace. ... Search the documentation and look at some examples. ... This should be strait ... TDAVISJR ...
    (microsoft.public.dotnet.framework.aspnet)
  • Re: OracleClient still good in Framework 2?
    ... Richard Lewis Haggard ... System.Data.OracleClient namespace seem to be alive and well... ... documentation has a warning in big red letters, "Note: ... If the class is no longer valid, is there a replacement that can be used ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: Smart Devices
    ... I can set only refrences to following; ... SqlClient is a Namespace, not a DLL. ... Look in the documentation of the class to find the dll it's located in. ...
    (microsoft.public.dotnet.languages.vb)
  • Re: How to get the first item in Dictionary?
    ... the OrderedDictionary class in the System.Collections.Specialized namespace ... I couldn't find anything in the documentation for OrderedDictionary that supports *or* refutes that. ... All that the "Ordered" means is that you can use an index to retrieve elements from the collection, and that which element corresponds to which index is undefined. ...
    (microsoft.public.dotnet.languages.csharp)