First, in the system design stage, we need to clarify technical requirements such as the system architecture and coding specifications to develop the checklist (for coding specifications, when a tool can be used for check, the key points that can be checked by the tool are not listed in the prepared checklist .)
The second step is to determine how the problem is recorded during code lookup. You can use the document method for recording (which is used in many projects) or the defect tracking system for recording.
After the preparation is complete and the project enters the coding stage, we can officially start code lookup. To change the disadvantages of the previous post-event check, we moved the code lookup activity to the coding synchronization with the programmer. This is done to promptly discover and solve problems. The implementation steps are as follows:
1) the person in charge of code query obtains the code to be checked from the construction database;
2) read the code and check the code according to the prepared checklist. Check whether the Code meets the relevant technical requirements, whether the Code meets the business requirements, and promptly record the problems found;
TIPS: You can use tools to check the required code before or after reading the code. Available tools include checkstyle, codepro, findbugs, metrics, and jdepend.
3) If reusable methods or modules are found to be available for extraction during code reading, record and notify the project architecture owner in a timely manner, it is responsible for the compilation of reusable methods;
4) inform the programmer of the Code query results in a timely manner, and the programmer modifies the problems found. If necessary, you need to explain and provide guidance to the programmer on issues found during code lookup;
5) track the solution progress of the problem found during code walk-up until the problem is all closed;
6) Repeat the preceding steps every day until all function codes are completed.
The preceding code check activity shows that the code check personnel assume an important role in the project. Therefore, it is extremely important to arrange appropriate people for code lookup. It can be said that it is directly related to the final results of code lookup activities.
Generally, we can arrange a function designer to perform Code lookup for the function. There are several advantages:
First, the functional designers have clear business requirements for the functions, so that they can easily understand whether the Code Compiled by programmers can meet the design requirements and business requirements. In fact, it is also a design check from another perspective;
Second, the functional designers are usually senior personnel who can provide effective guidance and assistance to programmers. from another perspective, they are also on-job training for programmers.
In the process of implementing code lookup, we also need to use tools to improve our efficiency, but we should not rely too much on tools or just rely on tools. At the same time, it is also necessary to change the trend of code lookup for code lookup, because it cannot play the role of code lookup and ultimately achieve the purpose of code lookup.
In practice, the way to record problems during code lookup also affects the efficiency of code lookup. Here we will introduce Jupiter, a plug-in for code query in eclipse. It provides a simple and convenient way to record and track problems found during code lookup.