Coding Guidelines

We are lucky to have a client that is tech savvy. And most of the times our code is being reviewed by their tech architects.  Most of the times we get reviewed our code on a frequent time intervals. On one side it is good, on the other side it leaves our developers with some morel loss. Adding to the fuel, is me. I insist my developers to follow certain standards within their code. It is time to post the general points that I emphasize.


1)    Use long names for variables
2)    Initialize variables at the time of declaration
3)    Use .Equals instead of ==
4)    Use territory operator ?:
5)    Use ?? when expecting the null reference
6)    Use .Length() comparison  to validate string with values
7)    Use StringBulder instead of strings concatenation
8)    Use StringBuilder replace instead of string (Ref : http://dotnetperls.com/replace-string-use)
9)    Use single line assignments for common values
10)    Avoid try catch as much possible
11)    Organize Usings and remove & sort the references
12)    Use white spaces within every expression
13)    Separate user methods from system generated methods. Use of Region
14)    Give Author details on every page
15)    Maintain the history of modification
16) Write the code in as small reusable methods as possible.
17) Never assing objects to null when they are within the loop
18) If you can use the GC.KeepAlive, make the best use of it
19) Try to separate the Finalze method into a different class and instantiate in the caller class that implements the IDisposable interface
20) Make use of WeakReference to avoid the multiple connections / reads from static content
21) Use int.TryParse, instead of Convert.ToInt or int.Parse
22) Never Ever Trust the User Input, do use Encoding where ever necessary

There are much more, this list would never end. But these are general guidelines that are in my mind at any given time. And different approaches can be identified depending on the situation that the code is in.

Comments

Post a Comment

Popular posts from this blog

Network Intrusion Detection using Supervised ML technique

Declaimer This is my initial version of the synopsis for PhD studies. There are plenty of things that i have to complete before i prepare the final version. Thus, this would be the alpha version. Due to the length of the blog post, will not be posting the entire draft. 1.Title of the thesis Network Intrusion Detection using Supervised Machine Learning Technique with Feature Selection 2.Introduction Intrusion Detection System, IDS, is a development which improve the network security and defending the information of the association. The IDS encourage the network chairman to recognize any malicious action on the network and alarms the executive to get the information made sure about by taking the appropriate activities against those attacks. An intrusion alludes to any unauthorized access or malicious usage of data assets. An intruder or an attacker is a true element that attempts to discover a way to increase unauthorized access to data, causes hurt or take part in different
Read more

Common mistakes by Interviewer

Now-a-days am conducting few interviews for our organization. While sitting in the other side of the table, I've visualized why most of the interviews fail with me. But when conducting these interviews, most of the candidates are attending with self confidence that they are suitable for the mentioned role and attend without preparation. When people do some real preparation, they tend to fail due to lack of awareness at the interviewer towards interviewing techniques. Having failed in many interviews, I've learned that the interviews fail because of the following... Reflection (or) Mirroring: The interviewer tends to see self within the candidate. The interviewer starts to compare self with the candidate and evaluate. This evaluation is totally personal. The yard stick for measuring the candidature is not generalized, but influenced.   Template (or) Checklist: The interviewer has a template of a questionnaire. The interviewer measures the candidate with respect to the list of st
Read more

Keep the system active, to avoid the auto lock

Most of the corporate offices will have a policy for screen locking. While working with a long running applications at background, like the automation scripts for testing the applications, it would be difficult to maintain the unlock state of the screen. Thus, we found a technique to keep the system active with a cheating technique. Below is the powershall scripts that keeps the system active ' I am clicking on NUMLOCK for every 5 seconds to keep the system awake Set objNetwork = CreateObject("Wscript.Network")'to get user name numOfHours=inputbox("Hi " & objNetwork.UserName & ", How many hours you want me to be awake? :->") 'time variable conatins the time in hours Set WshShell = WScript.CreateObject("WScript.Shell") 'Creating an object for clicking keys from keyboard numOfMilliSecs=numOfHours*3600*1000 'converting hours to milli seconds While numOfMilliSecs>0 'runs until tym becomes zero WshShell.Send
Read more