Artifact: Code Analysis Guidelines |
Define and refine the styles and standards used by developers to write the implementation.
Domains: Development
Purpose
To maintain an implementation that's readable and consistent by everyone on the team.
Relationships
Fulfilled Slots | [Technical Implementation]
Roles | Responsible: Developer | Modified By: Developer
Tasks | Input To: Assure a Quality Solution Implement the Solution Analyze Runtime Behavior Analyze Runtime Behavior Analyze Target Assure a Quality Solution Conduct Security Assessment Fix Vulnerabilities Identify Targets of Test Implement the Solution Integrate and Create Build Run Performance Test Run Tests Define Testability Elements Identify Test Ideas | Output From: Assure a Quality Solution
Description
Main Description | Code analysis guidelines includes information for the static and runtime evaluation of the implementation (code). Static guidelines focus on code that is not currently running. Dynamic guidelines focus on evaluating the behavior of the software as the code is executing. Static analysis includes: Coding guidelines that give the implementation a familiar look and feel to everyone on the team, and make it easier to find code blocks and commonly used areas of code (methods, case statements, etc). These guidelines makes the code more maintainable and more efficient to produce. Code dependency that evaluates how different implementation modules depend upon each other. This can improve coupling and cohesion at the implementation level, for example. Code complexity that helps developers judge if the code has become too complex to be maintained efficiently. See the definition of runtime analysis for more information. Automated tools and techniques can cover more areas of static and runtime analysis. Use this work product to list all the areas that need to be examined in the implementation and the tools used to examine the implementation.
Key Considerations
The most important thing about coding guidelines is to have them. Everyone has their stylistic preferences, but a enforcing a single style greatly improves readability and maintainability. Avoid ignoring coding guidelines just because it's difficult to come to agreement. Choose a set of guidelines get coding.
More Information
Checklists | Code Review
© Copyright IBM Corp. 1987, 2009. All Rights Reserved.