Detailed table of contents

• Course Introduction
  • Welcome
  • Course Goals
  • Teaching
  • Course Notes
  • Course Grade
  • Schedule of Assignments
  • Participation
  • Recommended Reading
  • Course Overview
  • Further Reading
  • Exercises and Discussion Topics
• Code as Part of the Software Development Process
  • Code as a Scientific Communication Vehicle
  • Gains from High-quality Code
  • Recognize Low-quality Code
  • Requirements Can Lead to Strange Code
  • How to Familiarize Yourself with a Body of Code
  • Code Reading Reasons
  • Code as Exemplar
  • Maintenance and its Tools
  • Evolution
  • Porting
  • Refactoring
  • Reuse
  • Inspections
  • Further Reading
  • Exercises and Discussion Topics
• The Open Source Landscape
  • History
  • Free and "Free" Software
  • The Open Source Definition
  • Software Categories (FreeBSD Ports)
  • System Software
  • Language Processors
  • Graphics
  • Development Tools
  • Text Processing
  • Web and Application Servers
  • Desktop Applications
  • Open Source Software Forges
  • Influence on Product Development
  • Development Process Advantages
  • Development Process Problems
  • License Distribution (Sourceforge)
  • Legal Exposure
  • Web sites
  • Further Reading
  • Exercises and Discussion Topics
  • The Full Open Source Definition
• Tackling Large Projects
  • Design and Implementation Techniques
  • Directory Structure
  • Project Organization
  • Source Code is Not Only Code
  • Key Processes
  • Project-Specific Tools
  • Debug Messages
  • Logging
  • Assertions
  • Assertions in Java
  • Further Reading
  • Exercises and Discussion Topics
• Version Control
  • Version Control
  • The Great Debate
  • Version Control Operations
  • Branching
  • Revision Tree Example
  • Life Under a VCS
  • The Goodies
  • Example of a Change Log
  • Example of a File Difference List
  • Example of an Annotated Listing
  • Extracting Metrics
  • Tracking Example
  • Best Practices
  • Subversion Cheat Sheet
  • Git Cheat Sheet
  • Further Reading
• Build Management
  • The Build Process
  • Typical Project Dependencies
  • Example: Apache Project Dependencies
  • Example: Mozilla Dependencies
  • Example: Internet Explorer Dependencies
  • Tool Types
  • Makefiles
  • Part of an Apache Makefile
  • Make Problems and Solutions
  • The Ant Approach
  • Some ant Tasks
  • Example Ant Build File
  • The Maven Approach
  • Maven's Lifecycle
  • Automating System Configuration
  • Best Practices
  • Best Practices (Variables)
  • Further Reading
• Code-Reading Tools
  • Typical Tasks
  • Regular Expressions
  • Regular Expression Symbols
  • Character Classes
  • The Editor as a Code Browser
  • Code Searching with grep
  • Locating File Differences
  • Roll Your Own Tool: Implementation Options
  • Choosing an Implementation
  • A Simple Grep Program in Java ...
  • ... And its Equivalent in Perl
  • Tool Building Advice
  • Example: Signature Survey
  • Using the Compiler
  • Compiler Warning Messages
  • The Compiler as a Code-Reading Tool
  • Code Browsers
  • Code Browsers in OO
  • Beautifiers
  • Runtime Tools
  • Drawing Diagrams
  • Lab Tasks (Java)
  • Lab Tasks (Unix)
  • Further Reading
  • Exercises and Discussion Topics
• General Purpose Tools
  • The Unix Toolchest
  • Working with Unix Tools
  • Data Fetching and Generation
  • Selection
  • Processing
  • Summarizing
  • Plumbing
  • Example: Analyze Java Files
  • Example: Determine Commit Times
  • Example Result:Plotted Commit Times
  • Program Development
  • Outwit Tools
  • Outwit Examples
  • An Editor Checklist
  • Further Reading
  • Exercises and Discussion Topics
• Performance Measurement and Management
  • Program States
  • Measuring Workload
  • Workload and Tools
  • System Monitoring Tools
  • Profiling System Calls
  • Function Profiling
  • Profiling C/C++ Code with Gprof
  • A Flat Profile
  • A Call Graph Profile
  • Profiling Java Code with EJP
  • A Java Program Profile
  • Basic Block Counting in C/C++ Code
  • Architectural Inefficiencies
  • Architectural Profiling Tools
  • Memory Performance
  • Memory Profiling C/C++ Code with Valgrind
  • Example: sed under valgrind
• Inspection and Testing
  • Example: Processor Testing
  • Static Verification
  • Identified Issues
  • Some FindBugs Issues
  • A FindBugs Run
  • GCC Best Practices
  • C Compilation Example
  • Lint Best Practices
  • Tracing Tools
  • Using Tracing Tools
  • [sl]trace Tips and Tricks
  • Example: System Call Tracing
  • Example: Library Call Tracing
  • Unit Testing
  • JUnit Example
  • Textual Regression Testing
  • Example: Testing the Sort Program
  • Test Coverage in C/C++ Code
  • Example: Test coverage of Perl's source code versus the number of executed test cases
  • Further Reading
• Coding Standards and Conventions
  • File Names and Organization
  • Common File Names
  • Common File Extensions
  • Indentation
  • Formatting
  • Comments
  • Naming Convention Styles
  • Java Naming Conventions
  • Hungarian Notation
  • Programming Practices
  • Process Standards
  • Further Reading
  • Exercises and Discussion Topics
• Documentation
  • Documentation Types
  • Shortcut for Code Understanding
  • Specifications for Code Inspection
  • Obtain System Structure
  • Understand complicated algorithms
  • Obtain the Meaning of Source Code Identifiers
  • Rationale Behind Nonfunctional Requirements
  • Design Intelligence
  • Internal Programming Interfaces
  • Test Cases and Examples of Actual Use
  • Implementation Problems and Bugs
  • Development and Execution Environment Problems
  • Trouble Spots
  • Undocumented Features
  • Additional Documentation Sources
  • Common Open-Source Documentation Formats
  • Further Reading
  • Exercises and Discussion Topics
• Maintainability
  • Introduction
  • The Maintainability Index
  • Metrics for Object-oriented Programs
  • Dependency Metrics on Packages
  • Analyzability
  • Analyzability: Dependencies and Coupling
  • Changeability
  • Stability
  • Testability
  • Effects of the Development Environment
  • Further Reading
  • Exercises and Discussion Topics
• Course Projects
  • Deadlines
  • Team Form
  • Project Form
  • 2013 teams
• Hall of Fame
  • The Class of 2004
  • The Class of 2005
  • The Class of 2006
  • The Class of 2007
• Appendix: Basic Programming Elements
  • A Complete Program
  • Expand: A Larger Example
  • Declarations and visibility
  • Functions and Global Variables
  • while Loops, Conditions, and Blocks
  • switch Statements
  • for Loops
  • Loop Control Statements
  • Character Expressions
  • Boolean Expressions
  • goto Statements
  • Refactoring in the Small
  • Refactoring Example
  • Other Refactoring Changes
  • Assignment Expressions
  • Bit Manipulation
  • Reading Control Structures
  • Further Reading
  • Exercises and Discussion Topics
• Appendix: Advanced C Data Types
  • Pointers
  • Structures
  • Unions
  • Dynamic Memory Allocation
  • typedef Declarations
  • Further Reading
  • Exercises and Discussion Topics
• Appendix: Data Structures in C
  • Vectors
  • Asymmetric Bounds
  • Matrices
  • Tables
  • Stacks
  • Queues
  • Maps
  • Hash Tables
  • Sets
  • Singly Linked Lists
  • Doubly Linked Lists
  • Circular Linked Lists
  • Trees
  • Further Reading
  • Exercises and Discussion Topics
• Appendix: Collaboration
  • Mailing Lists
  • VCS Notifications (CVS)
  • Example Notification
  • Setting up CVS Notifications (CVS)
  • Setting up CVS Notifications (git)
  • Documentation is Ubiquitous
  • Wikis
  • Things to put on a wiki
  • Wiki Best Practices
  • Issue Tracking
  • Issue Reports
  • Example: Bugzilla
  • Severity of a Bug
  • An Issue's Lifecycle
  • Resolution Options
  • Example: Releasing
  • Bug Tracking Best Practices
  • Further Reading

• Contents

 
 Unless otherwise expressly stated, all original material on this page created by Diomidis Spinellis is licensed under a Creative Commons Attribution-Share Alike 3.0 Greece License.