ProjectPlan

This page is under construction.

---

• Project Plan
  • 1. Introduction
  • 2. Project Practices and Measurements
    • Coding Standards and Code Reviews
  • Code Review Checklist

Project Plan

1. Introduction

This plan covers the content and enablement portions of the PSPLogger 1.0 project.

2. Project Practices and Measurements

Coding Standards and Code Reviews

A comprehensive coding standard encompasses all aspects of code construction. While developers should prudently implement a standard, it should be adhered to whenever practical. Completed source code should reflect a harmonized style, as if a single developer wrote the code in one session.

The readability of source code has a direct impact on how well a developer comprehends a software system. Code maintainability refers to how easily that software system can be changed to add new features, modify existing features, fix bugs, or improve performance. Although readability and maintainability are the result of many factors, one particular facet of software development upon which all developers have an influence is coding technique. The easiest method to ensure a team of developers will yield quality code is to establish a coding standard, which is then enforced at routine code reviews.

Using solid coding techniques and good programming practices to create high-quality code plays an important role in software quality and performance. In addition, if you consistently apply a well-defined coding standard, apply proper coding techniques, and subsequently hold routine code reviews, a software project is more likely to yield a software system that is easy to comprehend and maintain.

Although the primary purpose for conducting code reviews throughout the development life cycle is to identify defects in the code, the reviews can also enforce coding standards in a uniform manner.

The PSPLogger team must adhere to the Design Guidelines for Developing Class Libraries document from Microsoft when writing code and when doing code review.

Code Review Checklist

• The transactions are completed as quickly as possible (started as late as possible and finished as soon as possible).
• The connections are opened and closed quickly (open the database connection in every method call, and close it before the method ends).
• Error handling is implemented properly (e.g. use error handling to make sure the connection is closed even if the SQL command generates an exception).
• Stateless design practices are followed (e.g. accept all the information needed for a method in its parameters, and return all the retrieved data through the return value).
• The client doesn't have the option to use wide-open queries (every query should judiciously select only the columns it needs. Also, restrict the results with a WHERE clause whenever possible).
• The Data Classes are identify with attributes ([DataObject?], [DataObjectMethod?(DataObjectMethodType?.Select, true)]).
• For security reasons, the programmer sanitized and validated every user input.

---

Copyright Š 2009, 2011 Paulo Sequeira, Lenin Sibaja

The PSPLogger project documentation is licensed under a Creative Commons Attribution 3.0 Unported License.