“Good code is written so that is readable, understandable, covered by automated tests, not over complicated and does well what is intended to do.”

SmartDB/PinkDB

Comments

Functions

User Input

Test-Driven Development (TDD)

KISS

DRY

The goal of DRY is to reduce repetition of code. If you need to call it more than once, make it a Function. If you need to call it more than once and in multiple programs, consider a "microservice" rather than repeating the code in each program.

YAGNI

Don't bloat your code with code you don't need yet. Don't put in a function that nothing calls yet. Add that function if/when that functionality becomes a concrete requirement.

SOLID

Single Responsibility Principle (SRP)

Open-Closed Principle

Liskov Subsitution Principle

Interface Segregation Principle

Dependency Inversion Principle

SoC

• See also "Functions" above.
• See also "Single Responsibility Principle (SRP)" above.

"One of the good examples of SoC is the MVC pattern where data (“model”), the logic (“controller”), and what the end-user sees (“view”) divided into three different sections and each part is handled independently. Saving of data to a database has nothing to do with rendering the data on the web." (3)

LoD

• Each unit should have only limited knowledge about other units: only units “closely” related to the current unit.

• Each unit should only talk to its friends; don’t talk to strangers.

• Only talk to your immediate friends.

"The fundamental notion is that a given object should assume as little as possible about the structure or properties of anything else (including its subcomponents), in accordance with the principle of "information hiding". It may be viewed as a corollary to the principle of least privilege, which dictates that a module possess only the information and resources necessary for its legitimate purpose." (4)

POLA

"a component of a system should behave in a way that most users will expect it to behave, and therefore not astonish or surprise users. The following is a corollary of the principle: If a necessary feature has a high astonishment factor, it may be necessary to redesign the feature." (5)

Facade Pattern

"a facade is an object that serves as a front-facing interface masking more complex underlying or structural code." (6)

Algorithms

• Sorting

• Recursion

• Searching

• Graph Algorithms

• Tree Algorithms

• Dynamic Programming

Big-O Analysis

The Twelve Factor App

Refactoring

"Refactoring consists of improving the internal structure of an existing program’s source code, while preserving its external behavior." (1)

"Refactoring does “not” mean: rewriting code, fixing bugs, improving observable aspects of software such as its interface" (1)

Factoring is "organizing code into useful fragments" (2)

Optimization

Bibliography & References