source_code_itself.adoc

Source Code Itself

Conventions, Idioms 🥷

• e.g. pep8, zen of python

import this

• https://peps.python.org/pep-0008/

• https://replit.com/languages/python3

⚠️ Redundant information in naming

Reduce useless noise

Repeated informations

package org.mycompany.worlddestroyer;
/**
* The implementation of the Death Star. (1)
* @author Joe@empire.org (2)
*/
public class DeathStarImpl // (3)
             implements DeathStarInterface // (4)
{}

1. Tells nothing more than the class signature

2. In internal projet, maybe rely on version control history

3. Of course it is an implementation

4. Of course it is an interface

• @author does not encourage collective code ownership

Which is more readable?

• Giving code a good name - Kevlin Henney

Domain Driven Design

• Ubiquitous Language

Domain Specific Languages

• Code that reads like prose

• Fluent interfaces

• Martin Fowler - Fluent Interface

• Martin Fowler - DSL