<!--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 (see Rules to Better SQL Databases​)

• SQL Server Object Naming Standard
• SQL Stored Procedure Naming Stan​dard - Avoid System Prefixes
  
• SQL Server Indexes Naming Standard 
  
• SQL Server Relationship Naming Standard 
  

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>

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

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

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

​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\";

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

/// <summary>
/// base class for command implementations
/// This is a work around as standard MVVM commands
/// are not provided by default.
/// </summary>
public class Command : ICommand
{
 // code
}​

​/// <summary>
/// base class for command implementations
/// This is a work around as standard MVVM commands
/// are not provided by default.
/// </summary>
///
/// <remarks>
///  Issue Logged here: https://github.com/SSWConsulting/SSW.Rules/issues/3
///</remarks>
public class Command : ICommand
{
 // code
}

​

​ 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
}
}

In the example the only expected values are "Development" and "Production". 

void Load(string environment)
{
  if (environment == "Development")
  {
    // set Dev environment variables
  }
  else
  {
    // set Production environment variables
  }
}

Consider later that extra environments may be added: e.g. "Staging"

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).

Now the code will throw an exception if an unexpected value is provided.

void Load(string environment)
{
  if (environment == "Development")
  {
    // set Dev environment variables
  }
  else if (environment == "Production")
  {
    // set Production environment variables
  }
  else
  {
    throw new InvalidArgumentException(environment); 
  }
}

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;
Connect Timeout=5"​

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 void AssignRightToLeft()
{
  // Validate Right 
  if (paraRight.SelectedIndex >= 0)
  { 
    // Validate Left 
    if (paraLeft.SelectedIndex >= 0)
    {
       string paraId = paraRight.SelectedValue.ToString();
       Paragraph para = new Paragraph();
       para.MoveRight(paraId);
       RefreshData();
    }
  }
}​

​

private void AssignRightToLeft()
{
  // Validate Right 
  if (paraRight.SelectedIndex >= 0)
  {
    return; 
  }
  
  // Validate Left 
  if (paraLeft.SelectedIndex >= 0)
  {
    return;
  }

  string paraId = paraRight.SelectedValue.ToString();
  Paragraph para = new Paragraph();
  para.MoveRight(paraId);
  RefreshData();
}

​ 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 bool Enable { get; set; }
public bool Invoice { get; set; }

public bool Enabled { get; set; }
public bool IsInvoiceSent { get; set; }

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

string message = "The database is not valid." + Environment.NewLine + "Do you want to upgrade it? ";

string message = "The database is not valid." + Environment.NewLine;
message += "Do you want to upgrade it? ";​

​​

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;
}

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]

​Exercise: Understand commenting

You have just added a grid that auto updates, but you need to disable all the timers when you click the edit button. You have found an article on Code Project (http://www.codeproject.com/Articles/39194/Disable-a-timer-at-every-level-of-your-ASP-NET-con.aspx) and you have added the work around.

Now what do you do?

Sub OnPagePreRender(ByVal sender As Object, ByVal e As EventArgs)
' Fix for pages that allow edit in grids
Me.FindControls(Of System.Web.UI.Timer).ForEach(Sub (c) c.Enabled = False)
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.";

​var example = new StringBuilder();
example.AppendLine("This is a very long string that is ");
example.Append(" 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.​

static int WriteLinesToFile(IEnumerable<string> lines)
{
  // We must declare the variable outside of the using block
  // so that it is in scope to be returned.
  int skippedLines = 0;
  var file = new System.IO.StreamWriter("WriteLines2.txt")
  foreach (string line in lines)
  {
    if (!line.Contains("Second"))
    {
      file.WriteLine(line);
    }
    else
    {
      skippedLines++;
    }
  }
  file.Dispose();
  return skippedLines;
}

static int WriteLinesToFile(IEnumerable<string> lines)
{
  // We must declare the variable outside of the using block
  // so that it is in scope to be returned.
  int skippedLines = 0;
  using (var file = new System.IO.StreamWriter("WriteLines2.txt"))
  {
    foreach (string line in lines)
    {
      if (!line.Contains("Second"))
      {
        file.WriteLine(line);
      }
      else
      {
        skippedLines++;
      }
    }
  } // file is disposed here
  return skippedLines;
}

​

static int WriteLinesToFile(IEnumerable<string> lines)
{
  using var file = new System.IO.StreamWriter("WriteLines2.txt");
  // Notice how we declare skippedLines after the using statement.
  int skippedLines = 0;
  foreach (string line in lines)
  {
    if (!line.Contains("Second"))
    {
      file.WriteLine(line);
    }
    else
    {
      skippedLines++;
     }
    }
    // Notice how skippedLines is in scope here.
    return skippedLines;
   // file is disposed here
}​

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​

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

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

int length = customer != null && customer.name != null ? customer.name.length : 0;  

int length = customers?.name?.length ?? 0;

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

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