SSWUpdate - Do you comment each property and method?
Microsoft Gold Partner Logo
SSW Tech Breakfast

[ the cutting edge ]

G'Day Developers!

Its important that you have a consistent code comment standard throughout an application, regardless of language. Therefore, other developers can quickly determine the workings of a function/sub/class/stored procedure. Ideally, code should be as simple and self-explanatory as possible. Exceptions should be noted in line, especially when there is a .NET catch statement for generic System.Exceptions (in VB6/Access - for a Resume Next statement or similar).

e.g. catch (InteropServices.COMException ex) //Catch all COM Exceptions from third party COM component

In JavaScript and HTML, you should put these comments between the
<HEAD> and  </HEAD>
tags. 

To delmit the comments (ie top and bottom), you should use the standard block comment markers of
<!-- and -->.

A css file should be delimited with the block comment marks of
/* and */.

If the file contains any function/sub module/class declaration, comments will be containted to each of them containing at least the following:

  • function/sub module/class name
  • role of the function/sub module/class declaration

Above a method or property declaration:
''' <summary>
'''
''' </summary>
''' <param name="sender"></param>
''' <param name="e"></param>
''' <remarks ></remarks>

The comments can be generated automatically by VS.NET
/// - C#
''' - VB.NET
Bonus - you can automatically generate documentation - but the number of clients that want this is minimal.

See more of the SSW Rules pages.

Adam Cogan

Got a comment for Adam? Email Adam

Sydney .NET User Group -
The best place to learn .NET for free in Sydney

.NET User Group

7 days to go!

Sydney .NET User Group
Wednesday 17th June 2009
5:45pm - 9:00pm
Microsoft, Sydney
1 Epping Road, North Ryde

Harness the Power of the Platform – Writing Windows 7 Applications by Andrew Coates

A smart developer stands on the shoulders of the giants that came before. Windows 7 is just around the corner. As a platform, it boasts a number of differentiating features that you as a developer can exploit for no additional charge. Come along to this demo-heavy exploration of the platform and the tools you need to make it shine. We’ll also have copies of the Release Candidate version of Windows 7 to distribute.

Andrew Coates has been a Developer Evangelist for Microsoft in Australia since January 2004. Before joining Microsoft, Andrew was an independent consultant specialising in database applications using Microsoft technologies including SQL Server, Visual FoxPro and Microsoft Office.
Andrew's wide range of experience includes telecommunications, SMB inventory, dispatch and accounting systems, using both web and rich client front ends. He has developed and delivered class room training and has mentored a number of developers in Visual FoxPro and SQL Server technologies.
Andrew has spoken at international conferences on Geographical Information Systems, health statistics and database maintenance and is a regular presenter at TechEd both locally and internationally. An MCPD, MCTS and MCSD, Andrew also holds a Masters degree in Civil Engineering. Andrew blogs at http://blogs.msdn.com/acoat.

SharePoint – 8 Tips from the Trenches by John Liu (aka Liuy)

John Liu (aka Liuy) rarely gets out of the hot and sticky SSW trench. Come hear his war stories dealing with SharePoint solutions. John has delivered SharePoint sites for clients such as Microsoft, WorleyParsons and the worst one Adam Cogan.

Topics he will cover are:

  1. Getting the design right
  2. Web Parts - All the good stuff you get for free
  3. Performance tips for publishing sites
  4. The dirty stuff – deployment
  5. Less manual steps via SPConfigModification
  6. Dark data - CAML
  7. The 3rd party tools you need
  8. Things needed in SharePoint 2010

To see more details and RSVP, please visit our facebook .NET group or our LinkedIn .NET group.


facebook LinkedIn

Canberra .NET User Group -
The best place to learn .NET for free in Canberra

Canberra User Group

5 days to go!

Canberra .NET Developers User Group
Monday 15th June 2009

Lunch: 12:30pm - 1:30pm
King O'Malley's Irish Pub
131 City Walk
Canberra City

Dinner: 4:30pm - 6:00pm
Microsoft Canberra Branch
Walter Turnbull Building
Level 2, 44 Sydney Ave
Barton ACT

Harness the Power of the Platform – Writing Windows 7 Applications by Andrew Coates

A smart developer stands on the shoulders of the giants that came before. Windows 7 is just around the corner. As a platform, it boasts a number of differentiating features that you as a developer can exploit for no additional charge. Come along to this demo-heavy exploration of the platform and the tools you need to make it shine. We’ll also have copies of the Release Candidate version of Windows 7 to distribute.

Andrew Coates has been a Developer Evangelist for Microsoft in Australia since January 2004. Before joining Microsoft, Andrew was an independent consultant specialising in database applications using Microsoft technologies including SQL Server, Visual FoxPro and Microsoft Office.
Andrew's wide range of experience includes telecommunications, SMB inventory, dispatch and accounting systems, using both web and rich client front ends. He has developed and delivered class room training and has mentored a number of developers in Visual FoxPro and SQL Server technologies.
Andrew has spoken at international conferences on Geographical Information Systems, health statistics and database maintenance and is a regular presenter at TechEd both locally and internationally. An MCPD, MCTS and MCSD, Andrew also holds a Masters degree in Civil Engineering. Andrew blogs at http://blogs.msdn.com/acoat.

To see more details and RSVP, please visit our facebook .NET group or our LinkedIn .NET group.

facebook LinkedIn

SharePoint 101 Workshop -
What every business person should know about SharePoint 2007

SharePoint

SharePoint 101 Workshop
Friday 12th June 2009
8:00am - 11:00am
SSW Office, Sydney
Suite 10, 81-91 Military Road, Neutral Bay
Cost: No Charge

Workshop Objective

This workshop will provide the attendees with:

  • An understanding of how key features of SharePoint can enhance business processes
  • An understanding of the costs, timelines, staff involvement and commitment a business will incur when implementing SharePoint

Workshop Outline

  • Why should your business use SharePoint 2007?
  • Differences between Windows SharePoint Services (WSS) and Microsoft Office SharePoint Services (MOSS)
  • Explanation and demonstration of the business challenges the SharePoint feature set solve
  • SharePoint in regards to implementation, costs and timelines
  • SharePoint 2007 and the User Experience (custom design)
  • SharePoint Development - What if I need more than SharePoint's out of the box functionality?
Find out more and Register

New Zealand SharePoint Conference 2009 -
Stop, Collaborate and Listen!

SharePoint

New Zealand SharePoint Conference 2009
Thursday 2nd July 2009 to
Friday 3rd July 2009
Wellingotn, NZ

SharePoint has rapidly become one of the most popular technology platforms for information workers throughout New Zealand so it's about time we all got together and shared our experiences and expertise as the community that we are.
This will be the New Zealand conference to learn about SharePoint 2007 with expert local and international speakers presenting on topics that will help you understand and succeed with your SharePoint implementations and add real value to your organisation and businesses.

In addition to the session content you'll have ample opportunities to network with your peers in the community and technical and industry experts including local and international Microsoft Most Valued Professionals and New Zealand's top Certified Partners.
Donít miss out on New Zealand's biggest SharePoint event of the year! Come and join the excitement of the first dedicated SharePoint conference in New Zealand!

Find out more and Register

VSTS Training in Sydney, Melbourne and Brisbane

VSTS Training by Enhance ALM

Great new courses on Visual Studio Team System including

  • VSTS Essentials
  • VSTS Essentials for Project Managers and Business Analysts
  • Essential Database Development with VSTS
  • TFS Admin Essentials

Enhance ALM is offering the following public courses in Sydney, Melbourne and Brisbane this month.

Each of the following courses have been developed to assist development teams gain the most from their investment in Visual Studio Team System.

  1. VSTS Essentials
    Duration: 2 days | Cost: $ 1,195 | Course outline
    Dates: Melbourne (15-16 Jun), Brisbane (22-23 Jun), Sydney (23-30 Jun)
  2. VSTS Essentials for Project Managers and Business Analysts
    Duration: 1 day | Cost: $ 595 | Course outline
    Dates: Melbourne (17 Jun), Brisbane (24 Jun), Brisbane (1 Jul)
  3. Essentials Database Development with VSTS
    Duration: 1 day | Cost: $ 595 | Course outline
    Dates: Melbourne (18 Jun), Brisbane (25 Jun), Brisbane (3 Jul)
  4. TFS Admin Essentials
    Duration: 1 day | Cost: $ 595 | Course outline
    Dates: Melbourne (19 Jun), Brisbane (26 Jun), Brisbane (2 Jul)

More Details
Secure online event registration is available at https://secure.enhancealm.com.au/registration/registrationwizard.aspx.

Please direct any queries to Anthony Borton ph: 0408 302 173 or email: Anthony Borton.

Featured Product: SSW Code Auditor

SSW Code AuditorAutomate your Code Reviews with SSW Code Auditor

Are you looking to eradicate bugs and ensure consistency? SSW Code Auditor is a code analysis tool that allows developers to take control of your code, ensuring large, complex source code can be simplified, cleaned and maintained. The built-in rules focus on the most popular .NET languages (C#, VB.NET) for both Windows Forms and ASP.NET; however, the flexibility of SSW Code Auditor allows the developer to add their own rules to target any language in any text file.

More on SSW's Code Auditor

Advertise with SSW

If you would like to advertise your product or service with SSW or would like to find out more about various advertising opportunities, please email your enquiry to sophiebelle or call: +61 2 9953 3000.

SSW Update

June 2009

Tech Breakfast

Join us for Tech Breakfast 16 days to go

SYDNEY: SharePoint - Yellow Brick Road

Friday, 26th June 2009
8:00am-11:00am

Come and join us as we learn how the largest public SharePoint site in Australia (www.WorleyParsons.com) got up and running.
Adam Cogan of SSW will share his experience and lessons learnt on this project. Adam will also show you how to “sexify“ the look and feel of your website.

Register Now

Employment

Due to the tremendous growth that our business has experienced over the last few months, we are seeking enthusiastic people to join the SSW team.

Our Company is based in Neutral Bay which is one of the most elegant and scenic areas of Sydney. SSW is an Australian owned progressive consulting firm specialising in building, implementing and maintaining Microsoft .NET software applications.

We are currently strongly looking for a SharePoint Developer.

We are also currently looking for:

  • ASP.NET, VB.NET, C#, OLAP, SharePoint Software Developer
  • Technical BDM in Melbourne, Brisbane, or Canberra
  • IT Senior Marketing Consultant (part-time)
  • Project Manager

Read more and Apply NOW...

Proudly developed by SSW Sydney Web Design