Geeks With Blogs
Michael Flanakin's blog Food for thought...

I recently took a look at the QuickCode.NET tool and found it to be pretty interesting. It's definitely worth looking into, but I have a suggestion...

Personally, I like to keep my code very organized. I have templates that I use for VB6/ASP, .NET, and Java projects. I think that it would be very helpful to tie something like this into QuickCode.NET. If for nothing else, to try and provide a standard way to organize classes would be outstanding. I'm not saying that my way is perfect - if anyone has suggestions on how they like to organize their classes, please let me know. I'm always up for better organization.

using System;

namespace Flanakin.Examples
{
  /// <summary>
  /// <c>MyClass</c> class.
  /// </summary>
  class MyClass
  {
    #region | Property Declarations |

    private int    m_intID;    // a unique identifier
    private string m_strText;  // the rendered text value

    #endregion


    #region | Initialization |

    /// <summary>
    /// Instantiates an instance of the <c>MyClass</c> class.
    /// </summary>

    public MyClass()
    { ... }

    #endregion


    #region | Property Accessors |

    /// <summary>
    /// Gets a unique identifier representing the
    /// <c>MyClass</c> object.
    /// </summary>

    public int ID
    {
      get { return m_intID; }
    }


    /// <summary>
    /// Gets or sets the rendered text value...or whatever.
    /// </summary>

    public string Text
    {
      get { return m_strText; }
      set { m_strText = value; }
    }

    #endregion


    #region | Methods [Public] |

    ...

    #endregion
  }
}

You get the idea - protected and private methods are after the public methods. I usually put all of my properties and methods in alphabetical order, but sometimes I question whether an order based on use would be more appropriate. Static/shared properties/methods are placed before the others in their respective regions. I have been using an Excel spreadsheet to do the property declarations and accessors to include my naming conventions. This can be done by QuickCode.NET, which I will probably try. At the same time, however, I would like to keep everything organized, which QuickCode.NET cannot do. Perhaps this could be built into QuickCode.NET.

Does anyone have any comments/suggestions? I'm sure several people will comment on my naming conventions. I feel very strongly about Hungarian notation. I won't get into it now, but know that I only use it for private and/or local variables.

If anyone's interested, I can post my ASP template. I can do the same for VB and/or Java, but they're basically the same as the template above. Just let me know.

Posted on Sunday, November 30, 2003 9:45 AM .NET , Java , Development | Back to top

Copyright © Michael Flanakin | Powered by: GeeksWithBlogs.net