Archive for the Category database

 
 

How to document DataSets

Most online resources talks about how to document class methods and properties .In this post I’m going to show how to comment your datasets to create professional and more convenient documentation .

Take a look at picture below.

DataSetDocument

To achieve such results, organize your XML tags in this way 

<summary>
[Method Sumamry]
</summary>
<value>
The dataset contains the following tables 
<remarks>
<list type="table">
 <listheader>
 <term>Table</term>
</listheader> 
 <item>
  <term>[Table Name]</term>
  </item>
</list>
</remarks>
Table [Table Name] contains the following fields: 
<remarks>
<list type="table">
 <listheader>
 <term>Field</term>
 <description>Description</description>
</listheader> 
 <item>
  <term>[Column Name]</term>
  <description>[Column Description]</description>
  </item>
</list>
</remarks>  
</value> 

The Comment snippet below, along with NDoc produced the MSDN-style formatted document.

/// <summary>
/// Gets the history entries.
/// </summary>
/// <value>
/// The dataset contains the following tables 
/// <remarks>
/// <list type="table">
///  <listheader>
///  <term>Table</term>
/// </listheader> 
///  <item>
///   <term>History</term>
///     </item>
/// </list>
/// </remarks>
/// 
/// 
/// Table History contains the following fields: 
/// <remarks>
/// <list type="table">
///  <listheader>
///  <term>Field</term>
///  <description>Description</description>
/// </listheader> 
///  <item>
///   <term>Method (<see cref="System.String"/>)</term>
///   <description>Method name</description>
///     </item>
///  <item>
///   <term>ExecutedTime (<see cref="System.DateTime"/>)</term>
///   <description>When the specific method was executed</description>
///     </item>
///  <item>
///   <term>Result (<see cref="System.float"/>)</term>
///   <description>Method result</description>
///     </item>
///  </list>
/// </remarks>  
/// </value> 

Technorati Tags:  Programming Net DataSet System.Data Document CHM

MS SQL Server 2005 – System Table Map

The SQL Server 2005 System Table Map shows the system tables integrated in SQL Server 2005, and the relations between them.

Download SQL Server 2005 System Table Map

Report design in a nutshell

Defining report data sources.
Using object data sources in Windows applications and Web sites.
Using Lists.
Using report parameters in local mode.
Designing master-detail reports.

[Via http://www.gotreportviewer.com]

IntelliSense style word completion for MS Query Analyzer, VS.NET

IntelliSense style word completion for MS Query Analyzer, VS.NET 2003, SQL Server Management Studio and VS 2005. PromptSQL, from Atadore, works with:Microsoft Query Analyzer,SQL Server Management Studio (Microsoft SQL Server 2005 CTP),Visual Studio.NET 2003 Visual Studio 2005 (Beta 2).It adds IntelliSense(r)-like word-completion for you when you are editing SQL using these products.

http://www.promptsql.com

DataSet Links

Interesting information about DataSet

DataSet FAQ – By ObjectSharp

Nix the DataSet?????? – Andrew Conrad

DataSets Are Not Evil – Jelle Druyts

Returning DataSets from WebServices is the Spawn of Satan and Represents All That Is Truly Evil in the World – Scott Hanselman

DataSets vs. Collections – Dino Esposito


Page 3 of 41234