Application Block Code Review

Application Block Code Review

This section describes the steps involved in performing a code review for an application block.

Input

The following input is required for a code review:

• Requirements (use cases, functional specifications, deployment scenarios, and security-related requirements for the target deployments)

Design-related documents (architecture diagrams and class interaction diagrams)

Code Review Steps

The process for an application block code review is shown in Figure 5.1.

Figure 5.1. The code review process for application blocks

As shown in Figure 5.1, application block code review involves the following steps:

1. Create test plans. Create test plans that list all test cases and execution details from a code review perspective.
2. Ensure that the implementation is in accordance with the design. The implementation should adhere to the design decided on in the architecture and design phase.
3. Ensure that naming standards are followed. The naming standards for assemblies, namespaces, classes, methods, and variables should be in accordance with the guidelines specified for the Microsoft® .NET Framework.
4. Ensure that commenting standards are followed. The comments in the implementation should adhere to the standards for the language used for developing the application block.
5. Ensure that performance and scalability guidelines are followed. The code should follow the implementation best practices for .NET Framework. This optimizes performance and scalability.
6. Ensure that guidelines for writing secure code are followed. The code should follow the implementation best practices. This results in hack-resistant code.
7. Ensure that globalization-related guidelines are followed. The code should follow globalization-related best practices in such a way that the application block can be easily localized for different locales.
8. Validate exception handling in the code. The goal of exception handling should be to provide useful information to end users and administrators. This minimizes unnecessary exceptions at the same time.
9. Identify the scenarios for more testing. During the white box testing phase, identify the scenarios that need more testing.