21. High-Quality Programming Code
Download as PPTX, PDF0 likes8,037 views
The document discusses the importance of high-quality programming code, emphasizing characteristics such as correctness, readability, maintainability, and adherence to code conventions. It highlights the distinction between external and internal software quality and provides guidelines on managing complexity and achieving quality through proper design and documentation practices. The content serves as an educational resource for software developers to enhance their coding standards and practices.
21. High-Quality Programming Code
- 1. High-Quality Programming Code Code Correctness, Readability, Maintainability Svetlin Nakov Technical Trainer www.nakov.com Software University http://softuni.bg
- 2. 2 ο§ Why Quality Is Important? ο§ Software Quality: External and Internal ο§ What is High-Quality Code? ο§ Code Conventions ο§ Managing Complexity ο§ Characteristics of Quality Code Table of Contents
- 3. What is High-Quality Programming Code?
- 4. 4 ο§ What does this code do? Is it correct? Why Quality Is Important? static void Main() { int value=010, i=5, w; switch(value){case 10:w=5;Console.WriteLine(w);break;case 9:i=0;break; case 8:Console.WriteLine("8 ");break; default:Console.WriteLine("def ");{ Console.WriteLine("hoho "); } for (int k = 0; k < i; k++, Console.WriteLine(k - 'f'));break;} { Console.WriteLine("loop!"); } }
- 5. 5 ο§ Now the code is formatted, but is still unclear. Why Quality Is Important? (2) static void Main() { int value = 010, i = 5, w; switch (value) { case 10: w = 5; Console.WriteLine(w); break; case 9: i = 0; break; case 8: Console.WriteLine("8 "); break; default: Console.WriteLine("def "); Console.WriteLine("hoho "); for (int k = 0; k < i; k++, Console.WriteLine(k - 'f')) ; break; } Console.WriteLine("loop!"); }
- 6. 6 ο§ External quality ο§ Does the software behave correctly? ο§ Are the produced results correct? ο§ Does the software run fast? ο§ Is the software UI easy-to-use? ο§ Is the code secure enough? ο§ Internal quality ο§ Is the code easy to read and understand? ο§ Is the code well structured? ο§ Is the code easy to modify? Software Quality
- 7. 7 ο§ High-quality programming code: ο§ Easy to read and understand ο§ Easy to modify and maintain ο§ Correct behavior in all cases ο§ Well tested ο§ Well architectured and designed ο§ Well documented ο§ Self-documenting code ο§ Well formatted What is High-Quality Programming Code?
- 8. 8 ο§ High-quality programming code: ο§ Strong cohesion at all levels: modules, classes, methods, etc. ο§ Single unit is responsible for single task ο§ Loose coupling between modules, classes, methods, etc. ο§ Units are independent one of another ο§ Good formatting ο§ Good names for classes, methods, variables, etc. ο§ Self-documenting code style What is High-Quality Programming Code? (2)
- 10. 10 ο§ Code conventions are formal guidelines about the style of the source code: ο§ Code formatting conventions ο§ Indentation, whitespace, etc. ο§ Naming conventions ο§ PascalCase or camelCase, prefixes, suffixes, etc. ο§ Best practices ο§ Classes, interfaces, enumerations, structures, inheritance, exceptions, properties, events, constructors, fields, operators, etc. Code Conventions
- 11. 11 ο§ Microsoft official C# code conventions ο§ Design Guidelines for Developing Class Libraries: http://msdn.microsoft.com/en-us/library/ms229042.aspx ο§ Java official code conventions ο§ http://www.oracle.com/technetwork/java/codeconvtoc-136057.html ο§ Semi-official JavaScript code conventions ο§ http://javascript.crockford.com/code.html, http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml ο§ Semi-official PHP conventions ο§ http://www.php-fig.org/psr/psr-1/ Code Conventions (2)
- 13. 13 ο§ Managing complexity has central role in software construction ο§ Minimize the amount of complexity that anyoneβs brain has to deal with at certain time ο§ Architecture and design challenges ο§ Design modules and classes to reduce complexity ο§ Code construction challenges ο§ Apply good software construction practices: classes, methods, variables, naming, statements, error handling, formatting, comments, etc. Managing Complexity
- 14. 14 ο§ Key to being an effective programmer: ο§ Maximizing the portion of a program that you can safely ignore ο§ While working on any one section of code ο§ Most practices discussed later propose ways to achieve this important goal Managing Complexity (2)
- 16. 16 ο§ Correct behavior ο§ Conforming to the requirements ο§ Stable, no hangs, no crashes ο§ Bug free β works as expected ο§ Correct response to incorrect usage ο§ Readable β easy to read ο§ Understandable β self-documenting ο§ Maintainable β easy to modify when required Key Characteristics of High-Quality Code
- 17. 17 ο§ Good identifiers names ο§ Good names for variables, constants, methods, parameters, classes, structures, fields, properties, interfaces, structures, enumerations, namespaces, ο§ High-quality classes, interfaces and class hierarchies ο§ Good abstraction and encapsulation ο§ Simplicity, reusability, minimal complexity ο§ Strong cohesion, loose coupling Key Characteristics of High-Quality Code (2)
- 18. 18 ο§ High-quality methods ο§ Reduced complexity, improved readability ο§ Good method names and parameter names ο§ Strong cohesion, loose coupling ο§ Variables, data, expressions and constants ο§ Minimal variable scope, span, live time ο§ Simple expressions ο§ Correctly used constants ο§ Correctly organized data Key Characteristics of High-Quality Code (3)
- 19. 19 ο§ Correctly used control structures ο§ Simple statements ο§ Simple conditional statements and simple conditions ο§ Well organized loops without deep nesting ο§ Good code formatting ο§ Reflecting the logical structure of the program ο§ Good formatting of classes, methods, blocks, whitespace, long lines, alignment, etc. Key Characteristics of High-Quality Code (4)
- 20. 20 ο§ High-quality documentation and comments ο§ Effective comments ο§ Self-documenting code ο§ Defensive programming and exceptions ο§ Ubiquitous use of defensive programming ο§ Well organized exception handling ο§ Code tuning and optimization ο§ Quality code instead of good performance ο§ Code performance when required Key Characteristics of High-Quality Code (5)
- 21. 21 ο§ Following the corporate code conventions ο§ Formatting and style, naming, etc. ο§ Domain-specific best practices ο§ Well tested and reviewed ο§ Testable code ο§ Well designed unit tests ο§ Tests for all scenarios ο§ High code coverage ο§ Passed code reviews and inspections Key Characteristics of High-Quality Code (6)
- 22. 22 1. Classes define specific structure for objects ο§ Objects are particular instances of a class 2. Classes define fields, methods, constructors, 3. properties and other members ο§ Access modifiers limit the access to class members 4. Constructors are invoked when creating new class instances and initialize the object's internal state 5. Properties expose the class data in safe, controlled way Summary
- 24. License ο§ This course (slides, examples, demos, videos, homework, etc.) is licensed under the "Creative Commons Attribution- NonCommercial-ShareAlike 4.0 International" license 24 ο§ Attribution: this work may contain portions from ο§ "High Quality Code" course by Telerik Academy under CC-BY-NC-SA license
- 25. Free Trainings @ Software University ο§ Software University Foundation β softuni.org ο§ Software University β High-Quality Education, Profession and Job for Software Developers ο§ softuni.bg ο§ Software University @ Facebook ο§ facebook.com/SoftwareUniversity ο§ Software University @ YouTube ο§ youtube.com/SoftwareUniversity ο§ Software University Forums β forum.softuni.bg