Archive for the Category development

 
 

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

Design Pattern Automation Toolkit (DpaToolkit)

Design Pattern Automation Toolkit (DpaToolkit) – A toolkit to build applications using design patterns, with ability  to generate code.

Features

  • Allow design patterns to be added into the design. The Application comes with all the 23 Gang of Four Design patterns. Not just the class diagram of the design pattern. The developers can also develop design pattern plug-ins using the application and use them.
  • Allow code generation routines to be plugged into the application for new languages. By programming for an interface, the developers can write their custom code generators and create a DLL.
  • Allow Reverse Engineering modules to be plugged into the application.
  • The design pattern plug-ins / projects are saved in XML format for cross-application portability.
  • The developers can customize the code generation (for ex: final in Java, sealed in C# etc.) by adding the metainfo for classes, methods, fields and parameters.
  • Provides dynamic help to the user. The user can get the details (such as summary and meta info) associated with a class/methods/fields by hovering the mouse on the respective visual element.
  • Image Generation in 4 formats: gif, jpeg, png, tiff
  • Distributed under the GNU General Public License

Technorati Tags:  Utility Software tools soft Net Java Patterns Programming

Simian – Similarity Analyser

Simian (Similarity Analyser) identifies duplication in C#,Java, C++, COBOL, ASP, HTML, XML, Visual Basic source code and even plain text files.
In fact, Simian can be used on any human readable files such as ini files, deployment descriptors …

Use Simian to analyze code and find areas in your code that could use refactoring.

[Via public MattBerther : ISerializable]

.Net localization (Hebrew version)

.NET supports Unicode and you can use variables and literals in your own language.Is it useful? I don’t know ,but looks amazing.

using System;
 
namespace Devintelligence.Localization
{
    /// <summary>
    /// Localization in Hebrew
    /// </summary>
    class Class1
    {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        [STAThread]
        static void Main(string[] args)
        {
            for( int ?????    = 0;?????<10;?????++ )
            {
                Console.Write("{0}", ????? );
            }
            Console.ReadLine();
        }
    }
}

[Via Abhinaba's blog]

Sample Monad Shell Scripts ( designed to run on Windows 2000, Windows XP, and Windows Server 2003 )

The Script Repository categorizes the best sample scripts written using the Windows Monad Shell.


Page 20 of 37« First...10...1819202122...30...Last »