JP2006018735A - Coding standard observance situation monitoring system - Google Patents

Abstract

<P>PROBLEM TO BE SOLVED: To make management work for coding standard observance of a whole software development project easier. <P>SOLUTION: The coding standard observance monitoring system 100 comprises: a whole control unit 101; a source acquisition part 102; an inspection processing part 103; a detection information totalizing part 104; and a totalization result display part 105. In the coding standard observance monitoring system 100, on the basis of execution definition information 111 and rule information 112 which are created and specified in advance every project by a person in charge of inspection, inspection processing is executed regularly and a coding standard observance situation report 130 is generated every project by totalizing results of the inspection processing. <P>COPYRIGHT: (C)2006,JPO&NCIPI

Description

  The present invention relates to a system for monitoring whether or not a source code created by a developer violates a predefined coding standard in a software development project.

In general, in a software development project, a coding standard is set in advance for source code constituting a system to be developed, and each developer performs coding according to this. In this case, each developer checks whether or not the coding is actually performed according to each rule, and an inspection person in charge checks whether each rule is observed in the source code of the entire project.
In this case, since the source code check work is performed by visually observing the source code based on the coding standard, the number of steps in the check work is large.
Therefore, as a tool for reducing the man-hours in the check work, a configuration of a diagnostic apparatus having a means for checking a source code coded by a developer based on a pre-defined coding standard has been conventionally known. (For example, refer to Patent Document 1).
Japanese Patent Application Laid-Open No. 06-028165

In such a diagnosis apparatus, usually, several hundred rules used as coding standards are prepared in advance, and the check processing is performed based on the rules selected by the developer or the person in charge of inspection.
As a check process, all source code is scanned based on each selected rule, and when a point that violates the rule is detected, the file name, line, rule name, pointed item, etc. are pointed out as a developer terminal or inspection person in charge Was displayed on the user terminal.
In the inspection process, the inspection person confirms the point indicated by the diagnostic device, instructs the developer to make a correction if necessary, and uses the diagnostic device again to confirm whether the correction has been made by the developer. Etc.
On the other hand, in the case of the developer's own check, the pointed out by the diagnostic device was arbitrarily corrected.
In the inspection process, the coding standard is usually thorough by repeating such a check and correction cycle several times. By using the diagnostic apparatus described in Patent Document 1, the number of man-hours related to the check work is reduced. I was trying.

However, since the said patent document 1 assumes that a developer or the person in charge of inspection performs an individual check work, the rules etc. which are included in a coding standard can be specified arbitrarily, and development is also carried out. The timing of the check process by the person was also arbitrary. Therefore, there is a possibility that the checking process for each developer may differ depending on the developer, such as an excess or deficiency in the rules to be applied, and the checking process may not be performed at a necessary timing. In addition, since it is impossible to grasp the status of the entire development project, such as the rule violation status of other developers, there is a possibility that correction work at an appropriate timing may not be performed.
In this case, the person in charge of inspection must specify the rules to be included in the coding standards, check whether or not check processing is performed, and perform the tabulation of check results by each developer. There was a possibility that it would cause an excessive burden on the original check work.
On the other hand, if the inspection person in charge checks all the source code, the rules to be applied and the timing of the check processing can be easily managed, but processing is necessary for a huge amount of source code. Also, there was a problem that the developer could not modify the source code without an instruction from the person in charge of inspection.
In particular, in recent software development projects, it is required to develop a large-scale system such as a Web system in a short period of time, which cannot be assumed when the prior art cited as a reference is shown, While the number of source code steps and the number of developers has become enormous, the check work has been required to be performed in as short a time as possible, and the burden on inspection personnel has tended to increase.
In addition, in project management, it is necessary to manage the progress of the project in consideration of the number and trend of rule violations in each project. Since it is necessary to check the status of each developer individually, there is a problem that the work efficiency of each other decreases.
Furthermore, inspectors may define more appropriate rules based on the total results of rule violation detection information (rule violation tendency, etc.) for the entire project. Judging the necessity of redefinition of rules based on the results was an excessive burden.

  The present invention is intended to solve the above-mentioned problems. For source code coded by a number of developers, the coding standard compliance status is checked and the check results are summed up periodically, and the summation results are given to project personnel. This makes it easy to manage the entire software development project, enables developers to make quick corrections, and provides documentation for redefining coding standards. The object is to provide a coding standards compliance monitoring system that allows presentation.

In order to solve the above problems, the present invention is a system for monitoring whether or not source code constituting a development target of a software development project is coded based on a coding standard, and collects the source code. Source acquisition means provided to the inspection processing means, inspection processing means for detecting source code that violates the coding criteria from the provided source code, and detection for collecting the detection results obtained from the inspection processing means An information totaling unit, a totaling result display unit for displaying the totaling result, the source code acquisition unit, the inspection processing unit, the detection information totaling unit, and the totaling based on preset execution frequency information Overall control of each execution with the result display means Characterized in that it comprises a control means.
The tabulation result display means includes means for generating a list of rules included in a predefined coding standard and displaying the number of violating source codes for each rule.
Further, the total result display means includes means for selecting display items for list display and changing the display order of the display items.
The coding standard observing status monitoring system includes means for selecting, setting, and executing rules included in the coding standard for each software development project.

With the above configuration, according to the present invention, it is possible to periodically check the coding standard compliance status, total the check results, etc., and have the project results including the developers and inspection personnel confirm the total results.
Therefore, for inspection personnel, by checking the aggregated results, it is possible to grasp the tendency of rule violations and correction status of the entire project, and to concentrate on the original management work and rule redefinition work. It becomes possible.
In addition, since the developer can check the rule violation detection information based on the checked result according to the standard unified for each project, the developer can make an appropriate correction based on the checked result, and the entire project. It is possible to proceed with their own work while confirming the status of rule violations, correction status, etc.
In addition, the project manager can perform progress management in consideration of the rule violation status, correction status, etc. in the entire project.
Further, by displaying the number of violations for each coding standard as a total result, it is possible to easily understand the tendency of rule violations.
In addition, since the display items of the total result can be arbitrarily set, it is possible to obtain a display form suitable for the management work of the person in charge of inspection or the project manager.
In addition, since the rules included in the coding standard can be set for each project, management based on different standards can be performed for each project.

Hereinafter, a coding standard compliance monitoring system according to an embodiment of the present invention will be described with reference to the drawings.
FIG. 1 is a block diagram showing a schematic configuration of a coding standard compliance monitoring system according to the present embodiment.
The coding standard observance monitoring system 100 is composed of an overall control unit 101, a source acquisition unit 102, an inspection processing unit 103, a detection information totaling unit 104, and a totaling result display unit 105.
Further, execution definition information 111 and rule information 112 are defined in advance as information necessary for the coding standard compliance monitoring process, and a source file storage unit 113 for storing information necessary for the coding standard compliance monitoring process; A detection information storage unit 114 and a count result storage unit 115 are provided.
The overall control unit 101 reads the execution definition information 111 specified by the inspection person in charge, and based on the setting information such as date and frequency defined in the execution definition information 111, the source acquisition unit 102, the inspection processing unit 103, and the detection The information totaling unit 104 and the totaling result display unit 105 are controlled to start and execute instructions. In the present embodiment, the overall control unit 101 is provided with execution definition information 111 and rule information setting means, and the inspection definition person can edit and set the execution definition information 111 and rule information.
The source acquisition unit 102 acquires the source file 121 from the designated development target storage unit 120 in accordance with an instruction from the overall control unit 101 and stores it in the source file storage unit 113. In this case, the source acquisition unit 102 also generates a list of acquired source files 121 and stores the list in the source file storage unit 113.
The inspection processing unit 103 executes an inspection process for each source file stored in the source file storage unit 113 based on the specified rule information 112 in accordance with an instruction from the overall control unit 101, and obtains a processing result. The detection information is stored in the detection information storage unit 114.
The detection information totaling unit 104 totals the processing results stored in the detection information storage unit 114 in accordance with an instruction from the overall control unit 101 and stores the result in the totalization result storage unit 115.
The totaling result display unit 105 acquires the totaling result information from the totaling result storage unit 115 according to an instruction from the overall control unit 101 and outputs the coding standard compliance status report 130.
With the above configuration, the coding standard compliance monitoring system 100 according to the present embodiment periodically performs inspection processing based on the execution definition information 111 and the rule information 112 created and designated in advance for each project by an inspection person in charge. At the same time, the results of the inspection process are aggregated to generate a coding standard compliance status report 130 for each project.

An outline of the coding standard compliance monitoring process performed by the coding standard compliance monitoring system 100 configured as described above will be described.
FIG. 2 is a flowchart showing an outline of the coding standard compliance monitoring process.
First, the overall control unit 101 performs scheduling based on the execution frequency defined for each project in the execution definition information (step S201), and starts the processing units 102 to 105 at a designated time for each project ( Step S202).
In response to an instruction from the overall control unit 101, the source acquisition unit 102 acquires the source file 121 from the development target storage unit 120 (a storage location of the source file included in the execution definition information), and stores the source file 121 in the source file storage unit 113. Store (step 203). In this case, the source location in the execution definition information is a copy of a source such as FTP (File Transfer Protocol) or HTTP (Hypertext Transfer Protocol) as necessary, in addition to the storage location of the source file 121 indicated by a network path or the like. Protocol, an ID for logging in to the source file or the storage location, a password, and the like are included, and the source file is accessed based on the information to make a copy.
In response to an instruction from the overall control unit 101, the inspection processing unit 103 refers to the application rule defined in the rule information based on the rule identification information included in the execution definition information, and is stored in the source file storage unit. An inspection process is performed on the source file 121, and a detection result of a portion that violates each rule is stored in the detection information storage unit 114 (step 204).
The detection information totaling unit 104 totals the detection results stored in the detection information storage unit 114 for each project in accordance with an instruction from the overall control unit 101, and stores the total results in the total result storage unit 115 ( Step 205). In this case, the detection results are tabulated, for example, for the number of detections for each source file 121 and the number of detections for each rule.
The totaling result display unit 105 generates the coding standard compliance status report 130 based on the totaling results stored in the totaling result information storage unit 115 for each project in response to an instruction from the overall control unit 101 (step 206). ).
As described above, the processing of steps 202 to 206 is periodically repeated at each designated time, and a coding standard compliance status report is generated as a result of totaling rule violation detection information.

Hereinafter, the details of the coding standard compliance status monitoring system 100 according to the present embodiment will be described.
FIG. 3 is a diagram illustrating an example of a data structure of the execution definition information 111 used for the coding standard compliance monitoring process.
The execution definition information 111 includes a list 301 of projects to be monitored and definition contents 303 for each execution item 302 in association with each project.
The execution item 302 includes an execution frequency 311, an application rule 312, and a source position 313.
The execution frequency 311 is information indicating the date and frequency of performing the inspection process, and is defined as “every Saturday at 18:00”, for example. The execution frequency can be set every 10 minutes, for example, when the correction history of the source file is monitored in real time.
The application rule 312 sets a rule to be applied to each project from among predefined rules.
The source location 313 indicates a location where the source file 121 is stored for each project, and includes a protocol, a login ID, a password, and the like as necessary in addition to the network path indicating the storage location of the source file 121.

FIG. 4 is a diagram illustrating an example of the data structure of the rule information 112.
The rule information 112 indicates a coding standard arbitrarily defined by the person in charge of inspection or the project manager, and includes a rule name 401 for uniquely identifying each rule, a category 402, a check content 403, an important Degree 404.

FIG. 5 is a diagram illustrating an example of a data structure of detection information stored in the detection information storage unit.
The detection information 500 includes a source file name 501 that indicates a source file in which a location that violates the rule information is detected, a line number 502 in the source file that indicates the violation location, and a violation rule name 503 that indicates the violation rule. It is.

FIG. 6 is a diagram showing source total result information constituting the total result information storage unit, and FIG. 7 is a diagram showing rule total result information.
The source tabulation result information 600 stores a source file name 601 for uniquely identifying a source file to be tabulated, and the number of cases 602 to 605 for each importance regarding violation detected in the source file. ing.
The rule aggregation result information 700 stores a rule name 701 for uniquely identifying a rule to be aggregated, an importance 702 set for the rule, and the number of detected cases 703 in the project to be checked. ing.

The details of the aggregation process for each piece of information stored in the aggregation result information storage unit as described above will be described.
FIG. 8 is a flowchart showing a counting process procedure performed by the detection result counting unit 104.
The detection information totaling unit 104 acquires a list of source files stored in the source file storage unit 113 (step 801), sets the source file name to be totaled in the totaling result storage unit 115 (step 802). ), The number of cases for each importance in the source total result information 600 is initialized (set to “0”) (step 803).
On the other hand, a list of application rules specified by the overall control unit 101 is acquired from the rules included in the rule information (step 804), and a rule name to be aggregated is set in the aggregation result storage unit 115 ( Step 805), the number of cases in the rule count result information 700 is initialized (set to “0”) (Step 806).
The detection information totaling unit sequentially acquires each record stored in the detection information storage unit (step 807).
The source file name included in the acquired record is searched from the source total result information 600 (step 808), the importance is acquired from the rule definition information based on the rule name included in the record (step 809), and the source total is calculated. In the record of the source file name retrieved from the result information 600, “1” is added to the value of the column corresponding to the importance acquired from the rule information 112 and updated (step 810).
The rule name included in the record is searched from the rule total result information 700 (step 811), and the importance obtained from the rule information 112 is stored in the importance column of the searched rule name (step 812). The number column is updated by adding “1” (step 813).
By repeatedly executing the processing of steps 808 to 813 for all records (step 814), the source totaling result information 600 and the rule totaling result information 700 are generated.

Next, specific examples of the coding standard compliance status report 130 created by the aggregation result display unit 105 based on the source aggregation result information 600 and the rule aggregation result information 700 stored in the aggregation result information storage unit 115 are shown in FIGS. This will be explained based on this.
FIG. 9 is a diagram showing an example of a source status confirmation table that constitutes a part of the coding standard compliance status report 130.
The source status confirmation table 900 includes a source file name 901 for uniquely identifying a source file in which a violation is detected, a number 902 to 905 for each importance detected in the source file, and the most important to notification. A total value 906 obtained by quantifying the number of violations for each importance level by a specific calculation formula, and an evaluation 907 that is evaluated based on the numerical value of the total value 906 and converted into an icon.
For example, the source file name 901 may be displayed on a detailed information display screen related to the source file by clicking on the source file name 901.
For the number of cases 902 to 905, for example, the display items may be selected and changed in order by the setting of the aggregation result display unit.
The calculation formula for calculating the total value 906 is, for example, a simple total of the number of cases 902 to 905, a total weighted for each importance, or several methods are prepared and can be changed by setting. Anyway.
The processing method for displaying the evaluation 907 may be changed depending on the range of the total value 806, for example. In this example, if there is even one most important rule violation, the rating is one star.

FIG. 10 is a diagram showing an example of a detailed confirmation table displayed for the source file specified in the source status confirmation table shown in FIG.
The source status detail confirmation table 1000 includes a display target source file name 1001, a list of detected rules 1010, and a source file display unit 1020.
The list 1010 further includes a detected rule name 1011, a link 1012 to a report for confirming the status of each rule, the importance 1013 of the rule, a message 1014 indicating the content of the rule violation, and a violation of the rule detected Line number 1015 in the source file.
The rule name 1011 may be displayed, for example, by clicking on the rule name 1011 so that another screen describing the rule and the correction method can be displayed.
For example, when the link 1012 is clicked, the display may be changed to a detailed information display screen for each rule.
The message 1014 and the line number 1015 may be displayed, for example, by clicking on the message 1014 and the line number 1015 so that the display part in the source file display unit 1020 is changed to the one having the corresponding line number as the head.

FIG. 11 is a diagram showing an example of a rule status confirmation table that constitutes a part of the coding standard compliance status report.
The rule status confirmation table 1100 includes reports 1110, 1120, 1130, and 1140 for each importance level. For example, the report 1110 related to the most important rule includes the number of rules 1111 classified as the most important, the number of violations 1112 detected by the rules classified into those, and the rule confirmation table 1113 for each importance.
The rule confirmation table 1113 for each importance includes a rule name 1114, a category 1115 of the rule, an importance 1116 of the rule, a title 1117 of the rule, and the number of violations 1118 detected by the rule.
For example, the rule name 1114 may be displayed on a detailed information display screen related to the rule by clicking on the rule name 1114.

FIG. 12 is a diagram showing an example of a detailed confirmation table displayed for a rule specified in the rule status confirmation table shown in FIG.
The rule status detail confirmation table 1200 includes a display target rule name 1201, a list 1210 of sources in which violations of the rule are detected, and a source file display unit 1220.
The list 1210 further includes a detected file name 1211, a link 1212 to a report for confirming the status of the file, the importance 1213 of the rule, a message 1214 indicating the content of the rule violation, and a violation of the rule detected It consists of line number 1215 in the source file.
For example, when the link 1212 is clicked, the display may be changed to a source-specific detailed information display screen such as the source status detailed confirmation table 1000.
The message 1214 and the line number 1215 may be displayed, for example, by clicking on the message 1214 and the line number 1215 so that the display part in the source file display unit 1020 has the corresponding line number as the head.

As described above, in the coding standard compliance status monitoring system 100 according to the present embodiment, the coding standard compliance status check and the check result tabulation are periodically performed, and the total result is a project including a developer and an inspection person in charge. It is possible to make the relevant person confirm.
Therefore, for inspection personnel, by checking the aggregated results, it is possible to grasp the tendency of rule violations and correction status of the entire project, and to concentrate on the original management work and rule redefinition work. It becomes possible.
In addition, since the developer can check the rule violation detection information based on the results checked according to the standard unified for each project, the developer can make appropriate corrections based on the check results and It is possible to proceed with each person's work while confirming the rule violation status, correction status, and the like. In particular, since the importance of each rule is included in the rule violation detection information, it is possible to easily determine the necessity of correction work.
In addition, the project manager can perform progress management in consideration of the rule violation status and the correction status in the entire project.
In addition, since the number of violations is displayed for each importance level of the rule as the total result, it is possible to easily grasp the tendency of rule violations.
In addition, since the display items of the total result can be arbitrarily set, it is possible to obtain a display form suitable for the management work of the person in charge of inspection or the project manager.
In addition, since the rules included in the coding standard can be set for each project, management based on different standards can be performed for each project.
In addition, in each report, the rule violation part can be displayed, so that it becomes easy for a developer or the like to understand the violation part and the content of the violation.

In the above embodiment, an example in which the coding standard compliance monitoring system is configured by one terminal is shown, but the present invention is not limited to this, and each processing unit may be provided in a plurality of terminals.
Further, the data structure of each information storage unit necessary for the coding standard compliance monitoring process is not limited to that shown in the above embodiment, and other information may be added.

1 is a block diagram showing a schematic configuration of a coding standard compliance monitoring system according to an embodiment of the present invention. It is a flowchart which shows the outline | summary of the process which the coding criteria compliance monitoring system which concerns on one embodiment of this invention performs. It is a figure which shows an example of the data structure of the execution definition information used for a coding standard compliance monitoring process. It is a figure which shows an example of the data structure of the rule information used for a coding standard compliance monitoring process. It is a figure which shows an example of the data structure of a detection information storage part. It is a figure which shows an example of the data structure of source total result information. It is a figure which shows an example of the data structure of rule total result information. It is a flowchart which shows the total process procedure which a detection information total part performs. It is a figure which shows the source status confirmation table as an example of the coding standard observance status report which a total result display part produces | generates. It is a figure which shows the source condition detailed confirmation table as an example of the coding standard compliance status report which a totaling result display part produces | generates. It is a figure which shows the rule status confirmation table as an example of the coding standard observance status report which a total result display part produces | generates. It is a figure which shows the rule status detailed confirmation table as an example of the coding standard compliance status report which a totaling result display part produces | generates.

Explanation of symbols

100 Coding Standard Compliance Status Monitoring System 101 Overall Control Unit 102 Source Acquisition Unit 103 Inspection Processing Unit 104 Detection Information Total Unit 105 Total Result Display Unit 111 Execution Definition Information 112 Rule Information 113 Source File Storage Unit 114 Detection information storage unit, 115 Total result storage unit, 130 Coding standard compliance status report.

Claims (4)

A system for monitoring whether the source code constituting the development object of a software development project is coded based on a coding standard,
Source acquisition means for collecting the source code and providing it to an inspection processing means;
Inspection processing means for detecting source code that violates the coding criteria from the provided source code;
Detection information counting means for counting the detection results obtained from the inspection processing means;
A counting result display means for displaying the counting result;
An overall control means for controlling the execution of the source code acquisition means, the inspection processing means, the detection information counting means, and the counting result display means based on preset execution frequency information; Coding standard compliance status monitoring system characterized by that. The counting result display means includes
The system according to claim 1, further comprising means for generating a list of rules included in a predefined coding standard and displaying the number of source codes in violation for each rule. The counting result display means includes
3. The coding standard observing status monitoring system according to claim 1, further comprising means for selecting a display item of the list display and changing a display order of the display items. The coding standard compliance monitoring system is
The coding standard observing status monitoring system according to any one of claims 1 to 3, further comprising means for selecting, setting, and executing rules included in a coding standard for each software development project.

Images