Vlad's Roam Garden

Powered by 🌱Roam Garden

clean code

This is an "Orphan" page. Its core content has not been shared: what you see below is a loose collection of pages and page snippets that mention this page, as well as snippets of this page that were quoted elsewhere.

Referenced in

when you develop software you invent a language

Evergreen clean code domain language DSL software language make-public

Write shy code

en Law of Demeter clean code coupling encapsulation make-public

when a group of values is passed around together it can indicate a missing concept

Evergreen clean code heuristic OOP make-public

the meaning of the code abstraction should be obvious from the call site

Evergreen clean code abstraction call site make-public

prefer structure over convention

seedling clean code architecture constraint make-public

treat challenges with writing unit tests as a feedback about your design

seedling clean code unit test design feedback make-public

function size isn't important

en clean code function abstraction make-public

good interfaces have small surface area

seedling design clean code interface coupling encapsulation information surface area make-public

Use explanatory variables

Evergreen clean code explanatory variable make-public

bad code kindles the urge to write comments

Evergreen clean code refactoring code/comment bad code make-public

Use Long Names for Long Scopes

en clean code code/name make-public

when we read code we execute the search algorithm in our mind

Evergreen clean code readability Cognitive Complexity overview note search algorithm make-public

employ the power of natural language to improve readability

seedling readability natural language clean code abstraction succinctness make-public

all code in the function should be at the same level of abstraction

seedling clean code broken windows theory function level of abstraction make-public

functions should be small

Evergreen clean code function make-public

readability can be understood in computational terms

Evergreen clean code readability make-public

reduce the number of things you need to be aware of to understand any given code block

Evergreen clean code code block evaluation context make-public

Keep knowledge local

seedling clean code encapsulation coupling make-public

abstraction allows you to ignore irrelevant details

Evergreen clean code abstraction make-public

Respecting level of abstraction

It's one of the core insights for writing clean code it underlies a lot of other principles