<!--SSW Code Auditor - Ignore next line(HTML)--> 
<a href="mailto:test@ssw.com.au">Contact Us</a>

​<a href="javascript:sendEmail('74657374407373772e636f6d2e6175')" onmouseover="javascript:displayStatus('74657374407373772e636f6d2e6175');return true;" onmouseout="javascript:clearStatus(); return true;">Contact Us</a>

Note: If you use Wordpress, use the Email Encoder Bundle plugin to help you encode email addresses easily.

We have a program called SSW CodeAuditor to check for this rule.​
We have a program called SSW Link​Auditor to check for this rule.​​​

As a rule of thumb, no methods should be greater than 50 lines of code. Long-winded methods are the bane of any developer and should be avoided at all costs. Instead, a method of 50 lines or more should be broken down into smaller functions.

​Ideally, you should keep design and code separate - otherwise, it will be difficult to maintain your application. Try to move all data access and business logic code into separate modules.

Bob Martin explains this best:

For Javascript / Typescript ​​

Google publishes a JavaScript style guide. 

Here are some key points:

• Use const or let – Not var 
  
• Use semicolons 
  
• Use arrow functions
  
• Use template strings 
  
• Use uppercase constants 
  
• Use single quotes
  

See 13 Noteworthy Points from Google’s JavaScript Style Guide​

For C# Java​​

See chapter 2: Meaningful Names Clean Code: A Handbook of Agile Software Craftsmanship​​

For SQL (not really relevant these days)​​

• SQL Server Object Naming Standard
• SQL Stored Procedure Naming Standard
• SQL Stored Procedure Formatting Standard 
• SQL Server Indexes Naming Standard 
  
• SQL Server Relationship Naming Standard 
• SQL Server Design Standards
  

Note that this rule should apply to any file or folder that is on the web. This includes TFS Team Project names and SharePoint Pages.

extremeemailsversion1.2.doc
Extreme Emails version 1.2.doc

Extreme_Emails_v1_2.doc
ExtremeEmails_v1_2.doc

<a href="http://sharepoint.ssw.com.au/Training/UTSNET/Pages/UTS%20NET%20Short%20Course.aspx">UTS Short Course</a>
<a href="file://fileserver/Shared%20Documents/Ignite%20Brisbane%20Talk.docx">Ignite Talk</a>

<a href="http://sharepoint.ssw.com.au/Training/UTSNET/Pages/UTSNETShortCourse.aspx">UTS Short Course</a>
<a href="file://fileserver/SharedDocuments/Ignite_Brisbane_Talk.docx">Ignite Talk</a>

​TODO: Partho

​Generally, version numbering should begin at 0.1. Once the project has been approved for release by the client or tester, the version number will be incremented to 1.0. The numbering after the decimal point needs to be decided on and uniform. For example, 1.1 might have many bug fixes and a minor new feature, while 1.11 might only include one minor bug fix.​

1. nameof expressions - allows us to get the name of the type of object

   Now when we throw an exception, we can use the name of expressions feature to create robust code, which is more resistant to common mistakes when refactoring. This is achieved by reducing the amount of hard coding.

   As you can see, when in the past you would have to write the following code:

   (if customer.Address.ZipCode == null) throw new ArgumentNullException("ZipCode");

   Figure: Bad example - Amount of boiler plate code for a simple task 
   

   Now you only have write:

   (if customer.Address.ZipCode == null) throw new ArgumentNullException(nameof(customer.Address.ZipCode));

   Figure: Good example - The same functionality as the Bad Example in a single line of code
   The benefit of this change is when refactoring our code, we don't need to worry about searching for magic strings. Which common slip through the cracks and lead to confusing error messages.
2. String Interpolation - greatly reduces the amount of boilerplate code required when working with strings

Formatting strings on the fly was previously a task which required a stack of boilerplate code. In the Visual Studio 2015, we can use the smart String Interpolation feature. Not only does this feature reduce the amount of code we have to write, it also improves code readability.

For example, before C# 6, we would write:

var s = String.Format("Profit is ${0} this year", p.TotalEarnings - p.Totalcost);

Figure: Bad example - Using the string format make the code difficult to read


Now we are able to:

var s = "Profit is ${p.TotalEarnings - p.Totalcost} this year";

Figure: Good example - Very human readable code


As can be seen above by making use of the new String Interpolation feature, the understandability of your code is greatly improved.

3. ​Null-conditional operators - makes checking for null as easy as inserting a single question mark

   This great new feature has had a raft of positive reactions from developers. The new Null-conditional operators feature boils down all of the previously laborious clunky code into a single question mark.
   

   For example, previously we would of had to write a chunk of code to achieve a simple task

   if(customers.Length != null) { int length = customers.Length; } else { int length = 0; }

   Figure: Bad example - Fragile code

   Now we are able to replace that chunk of code with a single line

   int length = customers?.Length ?? 0;

   Figure: Good example - Robust code
   

   The promise In short, these new features will save you time, and help you write cleaner, more robust code - what's not to love?

The brand should contain at least the following:

• Copyright declaration
• Purpose of the document/file
• Author name​​
  

If the file was modified by another developer, the comment should also contain:

• Reviewer name

​Header comments

On top of the file:

///<summary>
///'----------------------------------------------
/// Copyright 2017 Superior Software for Windows 
/// www.ssw.com.au All Rights Reserved.
///'----------------------------------------------
/// Comment: User class to handle user preference and login information
/// Authors:   DDK,PH
/// Reviewers: AC,RD
///</summary>
///'---------------------------------------------- 

​https://github.com/StyleCop/StyleCop ​​

​https://marketplace.visualstudio.com/items?itemName=VisualStudioPlatformTeam.MicrosoftCodeAnalysis2017​

UPDATE: See Robert Martin Chapter 4: Comments  Clean Code: A Handbook of Agile Software Craftsmanship

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 delimit 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 contained​​ 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.

Example of commenting a method, it is strongly recommended that you add an adequate comment for your updating.

'Private Sub iStopwatchOptionsForm_Resizing(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Resize
'If Me.WindowState = FormWindowState.Minimized Then
'Me.Hide()
'End If
'End Sub

'
'Commented - we don't need to hide this from when it is minimum size, just leave it on taskbar.
' FW, 11/01/2018
'
'Private Sub iStopwatchOptionsForm_Resizing(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Resize
'If Me.WindowState = FormWindowState.Minimized Then
'Me.Hide()
'End If
'End Sub

Private Sub iStopwatchOptionsForm_Closing(ByVal sender As System.Object, ByVal e As System.ComponentModel.CancelEventArgs) Handles MyBase.Closing
'Don't close this form except closing this application - using hide instead;
If Not Me.m_isForceClose Then
If Me.IsOptionsModified Then
If MessageBox.Show("Do
you want to save the changes?", Me.GetApplicationTitle, MessageBoxButtons.YesNo,
MessageBoxIcon.Warning) = DialogResult.Yes Then
Me.SaveOptions()
End If
End If
End If
End Sub

Private Sub iStopwatchOptionsForm_Closing(ByVal sender As System.Object, ByVal e As System.ComponentModel.CancelEventArgs) Handles MyBase.Closing
'Don't close this form except closing this application - using hide instead;
If Not Me.m_isForceClose Then
'<added by FW, 11/10/2006>
' Remind saving the changes if the options were modified.
If Me.IsOptionsModified Then
If MessageBox.Show("Do you want to save the changes?", Me.GetApplicationTitle, MessageBoxButtons.YesNo, MessageBoxIcon.Warning) = DialogResult.Yes Then
Me.SaveOptions()
End If
End If
'</added>
...
End If
End Sub

As with other Task List entries, you can double-click any comment entry to display the file indicated in the Code Editor and jump to the line of code marked. More details for Task List comments.

Here is an example: when I open this options form, I see "ssw.com.au" in the email text box, but it is actually only half of the text in that textbox, see the following captures: 

Figure: You can see that ssw.com.au is highlighted.. and it is actually only half of the text in that textbox

Figure: scrolling left displays the full contents of the textbox

​​Figure: Bad example - the comment doesn't show in Task List window

Figure: Good example - Marked TODO in the comment, so you can see it in Task List window and double-click to jump to​

Figure: Good example - Marked HACK in the comment, so you can see it in Task List window and double-click to jump to

​Private Sub Command0_Click()
Dim dteTodayDate As Date
Dim intRoutesPerDay As Integer
Dim intRoutesToday As Integer
Dim dblWorkLoadToday As Double
dblWorkLoadToday = Date.Now()
.
....many lines of code...
.
intRoutesPerDay = 2
End Sub

Private Sub Command0_Click()
Dim dteTodayDate As Date
dteTodayDate = Date.Now()
.
....many lines of code...
.
Dim intRoutesPerDay As Integer
intRoutesPerDay = 2
.
....continuing code...
.End Sub

​if (ProductName == null) ProductName = string.Empty; if (ProductVersion == null)
ProductVersion = string.Empty; if (StackTrace == null) StackTrace = string.Empty;

if (ProductName == null)
{
ProductName = string.Empty;
}
if (ProductVersion == null)
{
ProductVersion = string.Empty;
}
if (StackTrace == null)
{
StackTrace = string.Empty;
}

​

​if (!IsValid)
{
// handle no error
}
else
{
// handle error
}​

if (IsValid)
{
// handle error
}
else
{
// handle no error
}

if (!IsValid)
{
// handle error
}

​string p2 = "\\My Documents\\My Files\\";

string p2 = @"\My Documents\My Files\";

​Friend Function RefreshSchema() As DialogResult
SSW.SQLAuditor.WindowsUI.QueryAnalysisForm.RunScript(Startup.PageQueryAnalyzer.txtScript.Text)
System.Windows.Forms.Application.DoEvents()​

'This is a sleep to delay the Application.DoEvent process
System.Threading.Thread.Sleep(500)
System.Windows.Forms.Application.DoEvents()
...​

​<add key="Connection" value="Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=Biotrack01;Data Source=sheep;"/>

<add key="Connection" value="Integrated Security=SSPI;Persist Security
Info=False;Initial Catalog=Biotrack01;Data Source=sheep;
Application Name=Biotracker"/> // Good Code - Application Name is added in the connection string.​

​Imports System.Windows.Threading
Imports System.Threading
''' <summary>
''' base class for command implementations
''' This is a work around as standard MVVM commands
''' are not provided by default
''' </summary>
''' <remarks></remarks>
Public MustInherit Class Command
Implements ICommand
Private m_dispatcher As Dispatcher
Protected Sub New()
If Not Application.Current Is Nothing Then
m_dispatcher = Application.Current.Dispatcher
Else
m_dispatcher = Dispatcher.CurrentDispatcher
End If
Debug.Assert(Not m_dispatcher Is Nothing)
End Sub
Public MustOverride Function CanExecute(ByVal parameter As Object) As Boolean Implements System.Windows.Input.ICommand.CanExecute
Public MustOverride Sub Execute(ByVal parameter As Object) Implements System.Windows.Input.ICommand.Execute
Public Event CanExecuteChanged(ByVal sender As Object, ByVal e As System.EventArgs) Implements System.Windows.Input.ICommand.CanExecuteChanged

Public Sub OnCanExecuteChanged()
If Not m_dispatcher.CheckAccess Then
m_dispatcher.Invoke(New ThreadStart(AddressOf OnCanExecuteChanged), DispatcherPriority.Normal)
Else
CommandManager.InvalidateRequerySuggested()
RaiseEvent CanExecuteChanged(Me, New EventArgs)
End If
End Sub
End Class

​Imports System.Windows.Threading
Imports System.Threading
''' <summary>
''' base class for command implementations
''' This is a work around as standard MVVM commands
''' are not provided by default
''' http://www.ssw.com.au/ssw/Standards/BetterSoftwareSuggestions/WPF.aspx#EmbraseMVVM
''' </summary>
''' <remarks></remarks>
Public MustInherit Class Command
Implements ICommand
Private m_dispatcher As Dispatcher
Protected Sub New()
If Not Application.Current Is Nothing Then
m_dispatcher = Application.Current.Dispatcher
Else
m_dispatcher = Dispatcher.CurrentDispatcher
End If
Debug.Assert(Not m_dispatcher Is Nothing)
End Sub
Public MustOverride Function CanExecute(ByVal parameter As Object) As Boolean Implements System.Windows.Input.ICommand.CanExecute
Public MustOverride Sub Execute(ByVal parameter As Object) Implements System.Windows.Input.ICommand.Execute
Public Event CanExecuteChanged(ByVal sender As Object, ByVal e As System.EventArgs) Implements System.Windows.Input.ICommand.CanExecuteChanged

Public Sub OnCanExecuteChanged()
If Not m_dispatcher.CheckAccess Then
m_dispatcher.Invoke(New ThreadStart(AddressOf OnCanExecuteChanged), DispatcherPriority.Normal)
Else
CommandManager.InvalidateRequerySuggested()
RaiseEvent CanExecuteChanged(Me, New EventArgs)
End If
End Sub
End Class

​

​ private void AMControlMouseLeftButtonUp(object sender, MouseButtonEventArgs e)
{
var auc = (AMUserControl)sender;
var aucSessionId = auc.myUserControl.Tag;
// snip snip snip
}

private void AMControlMouseLeftButtonUp(object sender, MouseButtonEventArgs e)
{
var auc = sender as AMUserControl;
if (auc != null)
{
var aucSessionId = auc.myUserControl.Tag;
// snip snip snip
}
}

​public class Example
{
public double salary()
{
}
}

​public class Sample
{
public double salary()
{
return 2500.00;
}
}

public interface IDemo
{
void DoSomethingUseful();
void SomethingThatCanBeIgnored();
}
public class Demo : IDemo
{
public void DoSomethingUseful()
{
// no audit issues
Console.WriteLine("Useful");
}
// audit issues
public void SomethingThatCanBeIgnored()
{
}
}

​​​public interface IDemo
{
void DoSomethingUseful();
void SomethingThatCanBeIgnored();
}
public class Demo : IDemo
{
public void DoSomethingUseful()
{
// no audit issues
Console.WriteLine("Useful");
}
// No audit issues
public void SomethingThatCanBeIgnored()
{
// stub for IDemo interface
}
}

Private Sub Command0_Click()
If My.MySettings.Default.Backend = "Access" Then
'Call this code ie. SQL commands
Else
'Must be SQL Server
'Call this other code ie. Stored Proc
End If
.....processing code
End Sub

Consider later on this code is updated... the programmer wishes to add an Oracle backend database option. So they modify the Backend property to include Oracle...

By using the above code, the wrong code will run because the above code assumes two possible situations. To avoid this problem, change the code to be defensive .g. Use an Else If statement (like below).

The user will then get a Logic Error and can report it to the programmer.​

Private Sub Command0_Click()
If My.MySettings.Default.Backend = "Access" Then
'Call this code ie. SQL
ElseIf My.MySettings.Default.Backend = "SQL Server" Then
'Call this other code ie. Stored Proc
Else
Throw New Exception( "Logic Error -- BackEnd is: "
& My.MySettings.Default.Backend)
End If
End Sub

When writing code to trap Logic Errors, use "Select Case" or "switch" statements to enhance readability. e.g. in VB.NET

Private Sub Command0_Click()
Select Case mDataset.Tables(0).Rows(0)("Key")
Case "1"
' Initialize the column list
strTempColumn = ""
Case "2"
' Ignore
End Select
.....processing code
End Sub

Private Sub Command0_Click()
Select Case mDataset.Tables(0).Rows(0)("Key")
Case "1"
' Initialize the column list
strTempColumn = ""
Case "2"
' IgnoreCase Else
Throw New Exception("Logic Error")
End Select
.....processing code
End Sub

private void btnOK_Click(object sender, EventArgs e)
{
rtbParaText.Clear();
var query =
from p in dc.GetTable()
select p.ParaID;
foreach (var result in query)
{
var query2 =
from t in dc.GetTable()
where t.ParaID == result
select t.ParaText;
rtbParaText.AppendText(query2.First() + "\r\n");
}
}

private void btnOK_Click(object sender, EventArgs e)
{
string paraText = Business.GetParaText();
rtbParaText.Clear();
rtbParaText.Add(paraText);
}

private void RaiseUIUpdateBidButtonsRed()
{
if (UIUpdateBidButtonsRed != null)
{
UIUpdateBidButtonsRed();
}
}

​​

private void RaiseSelectedLotUpdated()
{
if (SelectedLotUpdated != null)
{
SelectedLotUpdated();
}
}

​

int DepartmentId = GetDepartmentId()
if(DepartmentId == 1)
{
// do something
}
else if(DepartmentId == 2)
{
// do something #2
}
else if(DepartmentId == 3)
{
// do something #3
}
else if(DepartmentId == 4)
{
// do something #4
}
else if(DepartmentId == 5)
{
// do something #5
}
else
{
// do something #6
}

​

int DepartmentId = GetDepartmentId()
switch(DepartmentId)
{
case 1:
// do something
break;
case 2:
// do something # 2
break;
case 3:
// do something # 3
break;
case 4:
// do something # 4
break;
case 1:
// do something # 5
break;
case 1:
// do something # 6
break;
default:
//Do something here
break;
}

Further Reading: Speed Test: Switch vs If-Else-If​

​XmlDocument report = new XmlDocument();
XmlTextReader tr = new XmlTextReader(Configuration.LastReportPath);
report.Load(tr);

To perform validation:

XmlDocument report = new XmlDocument();
XmlTextReader tr = new XmlTextReader(Configuration.LastReportPath);
XmlValidatingReader reader = new XmlValidatingReader(tr);
report.Load(reader);

The XSD should be distributed in the same directory as the XML file and a relative path should be used:

<Report> <Report xmlns="LinkAuditorReport.xsd">
... </Report>​​

​"Integrated Security=SSPI;Initial Catalog=SallyKnoxMedical;Data
Source=TUNA"

"Integrated Security=SSPI;Initial Catalog=SallyKnoxMedical;Data Source=TUNA;
<b>Connect Timeout=5;</b>"

Match MatchExpression(string input, string pattern) 

private Match MatchExpression(string input, string pattern) 

We have a program called SSW Code Auditor to check for this rule.

Private Sub AssignRightToLeft()
'Validate Right
If lstParaRight.SelectedIndex >= 0 Then
'Validate Left
If lstParaLeft.SelectedIndex >= 0 Then
Dim paraID As String = lstParaRight.SelectedValue.ToString
Dim mParagraph As BusinessLayer.Paragraph = New Paragraph
mParagraph.MoveRight(paraID)
RefreshData()
End If
End If
End Sub 

​

Private Sub AssignRightToLeft()
'Validate Right and Left
If lstParaRight.SelectedIndex = -1 Then Return
If lstParaLeft.SelectedIndex = -1 Then Return
Dim paraID As String = lstParaRight.SelectedValue.ToString
Dim mParagraph As BusinessLayer.Paragraph = New Paragraph
mParagraph.MoveRight(paraID)
RefreshData()
End If
End If
End Sub

​ public Action
< connectioninformation > ConnectionProblem;

public event Action
< connectioninformation > ConnectionProblem;

1. Make sure one rule is enabled in code analysis and
   
2. One rule in StyleCop and
3. Get Code Auditor to zero

Related links:

• http://stackoverflow.com/questions/455269/refactoring-do-you-follow-the-boy-scout-rule​
• http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule​
  

Public ReadOnly Property Enable As Boolean Get Return true End Get End Property
Public ReadOnly Property Invoice As Boolean Get Return m_Invoice End Get End Property

Public ReadOnly Property Enabled As Boolean Get Return true End Get End Property
Public ReadOnly Property IsInvoiceSent As Boolean Get return m_IsInvoiceSent End
Get End Property

We have a program called SSW Code Auditor to check for this rule.​

DialogResult diaResult = MessageBox.Show(this,
"The database is not valid." + Environment.NewLine + "Do you want to upgrade it? ",
"Tip",
MessageBoxButtons.YesNo,
MessageBoxIcon.Warning);

DialogResult diaResult = MessageBox.Show(this,
"The database is not valid." + Environment.NewLine
+ "Do you want to upgrade it? ",
"Tip",
MessageBoxButtons.YesNo,
MessageBoxIcon.Warning);

​​

return string.Join(Environment.NewLine, paragraphs);

​

​​​

Figure: Bad example - popup dialog at the end of a long process

Figure: Good example - show time taken in the status bar

​System.Text.StringBuilder myStringBuilder = new System.Text.StringBuilder();

using System.Text;
...
...
StringBuilder myStringBuilder = new StringBuilder();

​

If you have ReSharper installed, you can let ReSharper take care of this for you:

Figure: Right click and select "Reformat Code..."

Figure: Make sure "Shorten references" is checked and click "Reformat"​

Cursor cur;
try
{
...
cur = Cursor.Current; //Bad Code - initializing the variable inside the try block
Cursor.Current = Cursors.WaitCursor;
...
}
finally
{
Cursor.Current = cur;
}

Cursor cur = Cursor.Current; //Good Code - initializing the variable outside the try block
try
{
...
Cursor.Current = Cursors.WaitCursor;
...
}
finally
{
Cursor.Current = cur;
}

​Private Sub ShowMyMessage()
MessageBox.Show("Are
you sure you want to delete the team project """ + strProjectName
+ """?" + Environment.NewLine + Environment.NewLine + "Warning:
Deleting a team project cannot be undone.", strProductName + "
" + strVersion(), MessageBoxButtons.YesNo, MessageBoxIcon.Warning, MessageBoxDefaultButton.Button2)

Private Sub ShowMyMessage()
MessageBox.Show( _
"Are you sure you want to delete the team project """ + strProjectName + """?"
_ + Environment.NewLine _ +
Environment.NewLine _ +
"Warning: Deleting a team project cannot be undone.", _
strProductName + " " + strVersion(), _
MessageBoxButtons.YesNo, _
MessageBoxIcon.Warning, _
MessageBoxDefaultButton.Button2)
End Sub

Public Enum ProjectLanguageEnum CSharp VisualBasic End Enum

Public Enum ProjectLanguage CSharp VisualBasic End Enum

We have a program called SSW Code Auditor to check for this rule.

​

Figure: Bad example

​

Figure: Good example​​

If using SQL Authentication
Server=DRAGON;Database=SSWData2005;Uid=SSWWebsite;Pwd=password;Application Name=SSWWebsite
If using Windows Authentication (Recommended)
Server=DRAGON;Database=SSWData2005;Integrated Security=True;Application Name=SSWWebsite

"This is a workaround as per the suggestion 
"[URL]

​What do you do with your print statements? Sometimes a programmer will place print statements at critical points in the program to print out debug statements for either bug hunting or testing. After the testing is successful, often the print statements are removed from the code. This is a bad thing to do. Debugging print statements are paths that show where the programmer has been. They should be commented out, but the statements should be left in the code in the form of comments. Thus, if the code breaks down later, the programmers (who might not remember or even know the program to start with), will be able to see where testing has been done and where the fault is likely to be - i.e., elsewhere.

Private Sub Command0_Click()
rst.Open "SELECT * FROM Emp" 'Open recordset with employee records
'Exit sub if the count is greater than 1,000
If intCount > 1000 Then
Exit Sub
Else
EndIf
.....processing code
End Sub

Private Sub Command0_Click()
'Count will exceed 1,000 during eighteenth century
'leap years, which we aren't prepared to handle.
If intCount > 1000 Then
Exit Sub
Else
EndIf
End Sub

​You should use named parameters under these scenarios:

• When there are 4 or more parameters
• When you make use of optional parameters
• If it makes more sense to order the parameters a certain way​​
  

Further Information

• The System.Environment class provides the most general way of retrieving those paths
• The Application class lives in the System.Windows.Form namespace, which indicates it should only be used for WinForm applications. Other types of applications such as Console and WebForm applications use their corresponding utility classes
  

Microsoft's write-up on this subject can be found at Microsoft API and reference catalog.​

​ public event Action
< connectioninformation > ConnectionProblem;

public event Action
< connectioninformation > ConnectionProblemDetected;

​​​

​ts = TimeSpan.Parse(cboMyComboBox.Text)

ts = TimeSpan.Parse(FormatTimeSpanString(cboMyComboBox.Text))​

We have a program called SSW Code Auditor to check for this rule.

Private Sub SomeSubroutine()
'Your code here....
Exit Sub ' Bad code - Writing Exit Sub before End Sub.
End Sub

Private Sub SomeOtherSubroutine()
'Your code here....
End Sub

We have a program called SSW Code Auditor to check for this rule.

public void SaveUserProfile(
[Optional] string username,
[Optional] string password,
string firstName,
string lastName,
[Optional] DateTime? birthDate)

​

public void SaveUserProfile(
string firstName,
string lastName,
[Optional] string username,
[Optional] string password,
[Optional] DateTime? birthDate)

Note: When using optional parameters, please be sure to use named para meters

​​Private Sub Command0_Click()
CreateSchedule
End Sub
Sub CreateSchedule()
Dim dteDateStart As Date
Dim dteDateEnd As Date
dteDateStart = Format(Me.ctlDateStart,"dd/mm/yyyy") 'Bad Code - refering the form control directly
dteDateEnd = Format(Me.ctlDateEnd, "dd/mm/yyyy")
.....processing code
End Sub

Private Sub Command0_Click()
CreateSchedule(ctlDateStart, ctlDateEnd)
End Sub
Sub CreateSchedule(pdteDateStart As Date, pdteDateEnd As Date)
Dim dteDateStart As Date
Dim dteDateEnd As Date
dteDateStart = Format(pdteDateStart, "dd/mm/yyyy") 'Good Code - refering the parameter directly
dteDateEnd = Format(pdteDateEnd, "dd/mm/yyyy")
&....processing code
End Sub

​private void HideToSystemTray()
{
// Hide the windows form in the system tray
if (FormWindowState.Minimized == WindowState)
{
Hide();
}
}

private void HideToSystemTray()
{
// Hide the windows form in the system tray
// I found this solution at http://www.developer.com/net/csharp/article.php/3336751
if (FormWindowState.Minimized == WindowState)
{
Hide();
}
}

​

1. It can be updated easily with normal SQL e.g. Rolling over the current setting to a new value.
   
2. It can be used in joins and in other queries easily without the need to pass in parameters.
3. It can be used to update settings and affect the other applications based on the same database.​​
   

​[TestFixture] public class SqlValidatorReportTest { }

[TestFixture] public class HtmlDocumentTests { }  ​

We have a program called SSW Code Auditor to check for this rule.

Instead of:

private void RaiseUpdateOnExistingLotReceived()
{
if (ExistingLotUpdated != null)
{
ExistingLotUpdated();
}
}​

...use this event extension method:

public static void Raise<t>(this EventHandler<t> @event,
object sender, T args) where T : EventArgs
{
var temp = @event;
if (temp != null)
{
temp(sender, args);
}
}
public static void Raise(this Action @event)
{
var temp = @event;
if (temp != null)
{
temp();
}
}

That means that instead of calling:

RaiseExistingLotUpdated();

...you can do:

ExistingLotUpdated.Raise();

Less code = less code to maintain = less code to be blamed for ;)​

​public bool IsValidEmail(string email)
{
// Return true if it is in valid email format.
if (email.IndexOf("@") <= 0) return false;
if (email.EndWith("@")) return false;
if (email.IndexOf(".") <= 0) return false;
if ( ...
}

public bool IsValidEmail(string email)
{
// Return true if it is in valid email format.
return System.Text.RegularExpressions.Regex.IsMatch( email,
@"^([\w-\.]+)@(([[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$";
}

public bool IsValidUri(string uri)
{
try 
{ 
Uri testUri = new Uri(uri); 
return true; 
} 
catch (UriFormatException ex)
{ 
return false; 
} 
} 

public bool IsValidUri(string uri) 
{ 
// Return true if it is in valid Uri format.
return System.Text.RegularExpressions.Regex.IsMatch( uri,@"^(http|ftp|https)://([^\/][\w-/:]+\.?)+([\w- ./?/:/;/\%&=]+)?(/[\w- ./?/:/;/\%&=]*)?"); 
} 

You should have unit tests for it, see our Rules to Better Unit Tests for more information.​

Figure: Bad example - "Hard- coded string" works, but is a bad idea

Figure: Good example - Used Enums, looks good and is easy to manage

String strExample = "This is a very long string that is \r\n not properly implementing a new line.";

String strExample = "This is a very long string that is " + Environment.NewLine +
" properly implementing a new line.";

​​

Our views on backward compatibility start with asking these questions:

• Question 1: How many apps are we going to break externally?
• Question 2: How many apps are we going to break internally?
• Question 3: What is the cost of providing backward compatibility and repairing (and test) all the broken apps?

Let's look at an example:

We have a public web service /ssw/webservices/postcode/
If we change the URL of this public Web Service, we'd have to answer the questions as follows:

• Answer 1: Externally - Don't know, we have some leads:
  We can look at web stats and get an idea. 
  If an IP address enters our website at this point, it tells us that possibly an application is using it and the user isn't just following the links.
• Answer 2: Website samples + Adams code demo
• Answer 3: Can add a redirect or change the page to output a warning Old URL. Please see www.ssw.com.au/ PostCodeWebService for new URL
  

Because we know that not many external clients use this example, we decide to remove the old web service after some time.

Just to be friendly, we would send an email for the first month, and then another email in the second month.  After that, just emit "This is deprecated (old)."  We'll also need to update the UDDI so people don't keep coming to our old address.

We all wish we never need to support old code, but sometimes the world doesn't go that way, if your answer to question 3 scares you, then you might need to provide some form of backward compatibility or warning.

From: John Liu www.ssw.com.au
To: SSWALL
Subject: Changing LookOut settings

The stored procedure procSSWLookOutClientIDSelect (currently used only by LookOut any version prior to 10) is being renamed to procSSWLookOutClientIDSelect. The old stored procedure will be removed within 1 month.
You can change your settings either by:

• Going to LookOut Options -> Database tab and select the new stored procedure
  
• Upgrading to SSW LookOut version 10.0 which will be released later today
  

​public int Count;

public int Count
{
get
{
return _count;
}
set
{
_count = value;
}
}

We agree that the syntax is tedious and think Microsoft should improve this.​

​Store messages in the Message.resx

Catch(SqlNullValueException sqlex)
{
Response.Write("The value cannot be null.");
}

Catch(SqlNullValueException sqlex)
{
Response.Write(GetGlobalResourceObject("Messages", "SqlValueNotNull"));
}

Catch(SqlNullValueException sqlex)
{
Response.Write(Resources.Messages.SqlValueNotNull); 'Good Code - storing message in resource file.
} 

Module Startup Dim HelloWorld As String = "Hello World!" Sub Main() Console.Write(HelloWorld)Console.Read() End Sub End Module

Figure: Saving constant message in Resource

Module Startup Sub Main() Console.Write(My.Resources.Messages.Constant_HelloWorld) Console.Read() End Sub End Module

​

​public string myString
{
get
{
return ;
}
}

public string myString
{
get
{
return string.Empty;
}
}​

We have a program called SSW Code Auditor to check for this rule.​

SqlConnection conn = null;
SqlCommand cmd = null;
try
{
conn = new SqlConnection(ConnectionString);
cmd = new SqlCommand(sql, conn);
conn.Open();
cmd.ExecuteNonQuery();
}
catch(SqlException ex)
{
...
}
finally
{
if(cmd!=null)
{cmd.Dispose();}
if(conn!=null)
{conn.Dispose();}
}

FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read);
StreamReader sr = new StreamReader(fs); 

​

try
{
using (SqlConnection conn = new SqlConnection(ConnectionString))
{
using (cmd = new SqlCommand(sql, conn))
{
conn.Open();
cmd.ExecuteNonQuery();
conn.Close();
}
}
}
catch(SqlException ex)
{
...
}

using(FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read))
{
using(StreamReader sr = new StreamReader(fs))
{
...
}
}

​

public class WarningEmail
{
//...
public void SendWarningEmail(string pFrom, string pTo, string pCC, string pUser, string pPwd, string pDomain)
{
//...
MailMessage sMessage = new MailMessage();
sMessage.From = new MailAddress(pFrom);
sMessage.To.Add(pTo);
sMessage.CC.Add(pCC);
sMessage.Subject = "This is a Warning";
sMessage.Body = GetWarning();
SmtpClient sSmtpClient = new SmtpClient();
sSmtpClient.Credentials = new NetworkCredential(pUser, pPwd, pDomain);
sSmtpClient.Send(sMessage);
//...
}
}
public class ErrorEmail
{
public void SendErrorEmail(string pFrom, string pTo, string pCC, string pUser, string pPwd, string pDomain)
{
//...
MailMessage sMessage = new MailMessage();
sMessage.From = new MailAddress(pFrom);
sMessage.To.Add(pTo);
sMessage.CC.Add(pCC);
sMessage.Subject = "This is a Error";
sMessage.Body = GetError();
SmtpClient sSmtpClient = new SmtpClient();
sSmtpClient.Credentials = new NetworkCredential(pUser, pPwd, pDomain);
sSmtpClient.Send(sMessage);
//...
}
}

public class WarningEmail
{
//...
public void SendWarningEmail(string pFrom, string pTo, string pCC, string pUser, string pPwd, string pDomain)
{
//...
EmailHelper.SendEmail(pFrom, pTo, pCC, "This is a Warning", GetWarning(), pUser, pPwd, pDomain);
//...
}
}
public class ErrorEmail
{
public void SendErrorEmail(string pFrom, string pTo, string pCC, string pUser, string pPwd, string pDomain)
{
//...
EmailHelper.SendEmail(pFrom, pTo, pCC, "This is an Error", GetError(), pUser, pPwd, pDomain);
//...
}
}
public class EmailHelper
{
public static void SendEmail(string pFrom, string pTo, string pCC, string pSubject, string pBody, string pUser, string pPwd, string pDomain)
{
MailMessage sMessage = new MailMessage();
sMessage.From = new MailAddress(pFrom);
sMessage.To.Add(pTo);
sMessage.CC.Add(pCC);
sMessage.Subject = pSubject;
sMessage.Body = pBody;
SmtpClient sSmtpClient = new SmtpClient();
sSmtpClient.Credentials = new NetworkCredential(pUser, pPwd, pDomain);
sSmtpClient.Send(sMessage);
}
}

​

Figure: Bad example - "Magic Number" works, but is a bad idea

Figure: Good example - No Magic Number, looks good and is easy to manage​