jgs CSC 309 Software Engineering II Lecture 02: Software Metrics: Code Quality Dr. Javier Gonzalez-Sanchez [email protected] www.javiergs.com Building 14 -227 Office Hours: By appointment
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 7 § Knowing what is inside your source code is the first step in assessing the quality of the software product. § Knowing the quantity of work performed in generating the source code is the first step in determining the productivity of your software team. Software Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 9 § LOC – Lines of Code Metric. Including lines of a single brace or parenthesis § LOC are used to create time and cost estimates. § LOC are a tracking tool to measure the degree of progress on a module or project. § An experienced developer can gage a LOC estimate based upon knowledge of past productivity on projects. Size Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 10 § eLOC – effective Lines of Code Metric. Only code statements § An effective line of code or eLOC is the measurement of all lines that are not comments, blanks or standalone braces or parenthesis. These can inflate LOC metrics by 20 to 40 percent. § This metric more closely represents the quantity of work performed. Size Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 11 § lLOC – logical Lines of Code Metric. § These statements are terminated with a semi-colon. § The control line for the "for" loop contain two semi-colons but accounts for only one semi colon. Size Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 14 § Comment Line and Comment Percent Metric § The degree of commenting within the source code measures the care taken by the programmer to make the source code and algorithms understandable. § Poorly commented code makes the maintenance phase of the software life cycle an extremely expensive adventure. § Comments can occur by themselves on a physical line or be co-mingled with source code. The sum of the lines of code, comments and blank lines often exceeds the physical line count. This is expected a when comments are co-mingled with source code. § Comment Percent = Comment Line Count / (LOC) x 100 Understandability Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 15 § Blank Line and White Space Percent Metric § The number of blank lines within source code determines the readability of the product. White space accents the logical grouping of constructs and variables. Programs which use few blank lines are difficult to read and more expensive to maintain. § It counts the spaces and characters within the source code. The white space percentage metric is another measure of readability for the source product. § White Space Percentage = (Number of spaces / Number of spaces and characters) * 100 Understandability Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 16 § Average LOC per Function Metric. An accepted industry standard of 200 LOC per function is desired as the average LOC per function § Maximum LOC per Function Metric. § Minimum LOC per Function Metric. A minimum LOC per function of 2 or less can indicate functions that may have been prototype but not yet complete.. Function Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 18 § Cyclomatic Complexity. It is a quantitative measure of the number of linearly independent paths. § Paths occur when "while,” "for,” "if,” "case," and "goto" keywords appear within the function. § If the source code contained no control flow statements (conditionals or decision points), the complexity would be 1 § If the code had one single-condition IF statement, there would be two paths through the code: one where the IF statement evaluates to TRUE and another one where it considers to be FALSE. § Two nested single-condition IFs, or one block with two conditions, would produce a complexity of 3. Function Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 21 Complexity Number Meaning 1-10 Structured and well written code High Testability Cost and Effort is less 10-20 Complex Code Medium Testability Cost and effort is Medium 20-40 Very complex Code Low Testability Cost and Effort are high >40 Not at all testable Very high Cost and Effort Cyclomatic Complexity
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 25 What can you say? • Complexity of the Product • Work/Time/Payment to the team ? • Do you hire them? • Understandability of the code?
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 28 Office Hours Tuesday and Thursday 3 - 5 pm But an appointment required Sent me an email – [email protected]
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 33 Resource Standard Metrics (RSM) is a source code metrics and quality analysis tool for ANSI C, ANSI C++, C# and Java for use on all Windows* and UNIX operating systems. 1. Download RSM 7.75 Trial (Windows) here: http://msquaredtechnologies.com/ RSM-Download.html * Install the Windows version. It includes a easy to use friendly interface (RSM Wizard). Tool
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 34 2. Review the user manual here http://msquaredtechnologies.com /m2wizard/RSM_Wizard_Manual.htm Disclaimer: It is a FREE tool… Issues counting LOCs, eLOCs, Issues counting conditions (syntaxis analysis) BUT ±0..9 does not affect in biggest projects 🧐 Resource Standard Metrics
jgs Javier Gonzalez-Sanchez | CSC 309 | Winter 2023 | 37 For your CSC 308 project, calculate and report the following in a table: § Total Number of Files, § Total Number of methods, § Average Number of methods per File § Total Number of lines § LOC, eLOC, lLOC, Lines of comments (Total and Average per File) § % Comments § %Blank lines § %Spaces, § Max Cyclomatic Complexity (CC) § Max Cyclomatic Complexity (CC) § Average Cyclomatic Complexity (CC) § Parameters (Total, Max, Average) § Return points (Total, Max, Average) Write a conclusion in 2 or 3 paragraphs explaining the qualities of your project, both positive ones and those that you would consider improving after reading these numbers. Work this with your team, and only one team member will submit it. Add all your names to the document (file) that you are submitting. Homework
jgs CSC 309 Software Engineering II Javier Gonzalez-Sanchez, Ph.D. [email protected] Winter 2023 Copyright. These slides can only be used as study material for the class CSC308 at Cal Poly. They cannot be distributed or used for another purpose.
javiergs
hirobe1999
coa00
yutootsuka
ivargrimstad
leichteckig
nagworld
hitoshi_a0
zoetrope
hiro_y
cocoeyes02
ogijun2018
gennei
skipperchong
jasonvnalue
brad_frost
destraynor
robhawkes
chriscoyier
afnizarnur
keithpitt
cherdarchuk
frogandcode
jcasabona
marktimemedia