Tech Carpenter - Ahmad Najjar's Blog

Regions Using regions is a very good practice, whereas a region lets you specify a block of code that you can expand or collapse. In longer code files, it is convenient to be able to collapse or hide one or more regions so that you can focus on the part of the file that you are currently working on. Comments & XML Documentation Comments are a short descriptive lines, explaining what a line or more of code should do, or might be addressing programmers about test code pieces or future changes. Comments usually comes in two forms: In-line comments:         public bool SendNotificationEmail( string toEmail,                                            string subject,                                            string body) ...

Improving methods definition would dramatically enhance your code readability and maintainability. The following are major practices that need to be considered while defining your methods. Parameters & Overload Methods Before digging deep, we need to define in brief what an overload method is. Basically, an overload method is having two or more methods within the same class, whereas these methods share the same exact name but differs from each other in one or more of the following: Parameters data types. Number of parameters. Order of parameters. So initially, and based on the previous definition, overload methods are all about changing the signature of a method based on the manipulation in its passed parameters, which would lead – if not used properly and wisely – of having multiple versions of the method not knowing which version is being used, and what is the value behind having all these methods definitions, thus: Make sure to use overload methods only if y...