“Coding For Humans” by Paola Ducolin, Staff Engineer @ Dashlane

CODING FOR HUMANS
Paola Ducolin |WiMLDS Paris | 14 Mai 2020

ABOUT MYSELF
• 🙋 Paola Ducolin 🇮🇹
• 💻 Staff Engineer @ Dashlane
• 👩💻 Ladies of Code Paris co-organizer
• 🏳🌈 Paris QueerJS organizer
• 👵 10+ years in software development
• 🤦 8+ years with legacy code
2

17:00 CEST, MAY 16TH @ TWITCH.TV/QUEERJS
5

WHAT ABOUT CODE?
Coding for humans | @PolaDuco WiMLDS Paris | 14 mai 2020 12

Coding for humans | @PolaDuco WiMLDS Paris | 14 mai 2020 13
bit.ly/QueerInTechPhotos

LEGACY CODE IMPACT ON MY FEELINGS
14

Coding life
Reading Writing
Source: Robert C. Martin
15

All code becomes legacy code
17
eventually

1. WRITING READABLE CODE
2. WRITING HUMAN DOCUMENTATION
19

Coding life
Reading Writing
Source: Robert C. Martin
20

HUMAN CODE
21
Use semantically
meaning names

EXAMPLES - NAMING
22
https://bit.ly/coding-for-humans
class Rectangle {
constructor(w, h) {
this.w = w;
this.h = h;
}
calcA() {
return this.w * this.h;
}
}

EXAMPLES - NAMING
23
class Rectangle {
constructor(width, height) {
this.width = width;
this.height = height;
}
calculateArea() {
return this.width * this.height;
}
}

EXAMPLES – NAMING 2
24
const LETTERS = "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM";
const CHARS = LETTERS + "1234567890!@#$%^&*()_-+=[]{}|/?><.,;:";

EXAMPLES – NAMING 2
25
const LETTERS = "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM";
const LETTERS_DIGITS_SYMBOLS =
LETTERS + "1234567890!@#$%^&*()_-+=[]{}|/?><.,;:";

HUMAN CODE
26
Use semantically
meaning names
Prevent reading inner
code

EXAMPLES – INNER CODE
27
var rectangle = new Rectangle(3, 5);
rectangle.increaseSize(0.3);
class Rectangle {
this.width = width;
}
increaseSize(percentage) {
this.width *= percentage;
this.height *= percentage;
}
}

28
var rectangle = new Rectangle(3, 5);
rectangle.scaleWidthAndHeightByFactor(0.3);
class Rectangle {
this.width = width;
}
scaleWidthAndHeightByFactor(percentage) {
this.width *= percentage;
this.height *= percentage;
}
}

29
// This is a comment

HUMAN CODE
30
Use semantically
meaning names
Prevent reading inner
code
Do one thing
Minimize function
length

EXAMPLES – MINIMIZE LENGTH
31
function Adjust(rectangle) {
rectangle.Size = Size.S;
rectangle.HasError = false;
rectangle.IsSquare = false;
if (rectangle.Width >= 10000)
rectangle.Size = Size.L;
if (rectangle.Height <= 100)
rectangle.HasError = true;
if (rectangle.Width ===
rectangle.Height) rectangle.IsSquare =
true;
rectangle.Size = Size.XL;
rectangle.Size = Size.M;
if (rectangle.Width <= 300)
}

32
import fc from "fast-check";
function test() {
fc.assert(
fc.property(fc.integer(0, 30000),
fc.integer(0, 30000), (width, height) => {
let rectangle = {
TotalPurchases: totalPurchases,
RecentOrders: recentOrders,
LovesJavaScript: lovesJavaScript,
KnowsCobol: knowsCobol,
};
let rectangle_expected =
JSON.parse(JSON.stringify(rectangle));
Adjust(rectangle_expected);
Adjust_new(rectangle);
expect(rectangle.Size).toBe(rectangle_expe
cted.Size);
expect(rectangle.HasError).toBe(rectangle_
expected.HasError);
expect(rectangle.IsSquare).toBe(rectangle_
expected.IsSquare);
})
);
}

33
true;
}

34
function AdjustSize(rectangle) {
if (rectangle.Height <= 200) rectangle.Size = Size.M;
else if (rectangle.Width >= 20000) rectangle.Size = Size.XL;
else if (rectangle.Width >= 10000) rectangle.Size = Size.L;
else rectangle.Size = Size.S;
}

35
true;
}

36
function AdjustHasError(rectangle) {
if (rectangle.Height <= 100 || rectangle.Width <= 300)
else rectangle.HasError = false;
}

37
function AdjustIsSquare(rectangle) {
if (rectangle.Width === rectangle.Height)
rectangle.IsSquare = true;
else rectangle.IsSquare = false;
}

38
function Adjust_new(rectangle) {
AdjustSize(rectangle);
AdjustHasError(rectangle);
AdjustIsSquare(rectangle);
}

HUMAN CODE
39
Use semantically
meaning names
Prevent reading
inner code
Do one thing
Minimize
function length
Top-down
narrative

EXAMPLES – TOP DOWN NARRATIVE
40
class Rectangle {
// helper functions BEGIN
#scaleWidthByFactor(scalingFactor) {
this.width *= scalingFactor;
}
#scaleHeightByFactor(scalingFactor) {
this.height *= scalingFactor;
}
// helper functions END
// frequently used functions BEGIN
ScaleWidthAndHeightByFactor(scalingFactor) {
this.#scaleWidthByFactor(scalingFactor);
this.#scaleHeightByFactor(scalingFactor);
}
// frequently used functions END
}

EXAMPLES – TOP DOWN NARRATIVE
41
class Rectangle {
// scaling functions BEGIN
ScaleWidthAndHeightByFactor(scalingFactor) {
this.#scaleWidthByFactor(scalingFactor);
this.#scaleHeightByFactor(scalingFactor);
}
#scaleWidthByFactor(scalingFactor) {
this.width *= scalingFactor;
}
#scaleHeightByFactor(scalingFactor) {
this.height *= scalingFactor;
}
// scaling functions END
}

HUMAN CODE
42
Use semantically
meaning names
Prevent reading
inner code
Do one thing
Minimize
function length
Top-down
narrative
Review with the
team
Use refactoring
tools

USE EMPATHY WHILE READING CODE
44
https://bit.ly/romeu-moura

1. WRITING READABLE CODE
2. WRITING HUMAN DOCUMENTATION
45

bit.ly/carolstran-human-docs
HUMANISING YOUR DOCUMENTATION - CAROLYN STRANSKY
46

HUMAN DOCUMENTATION
• Use inclusive and clear language
47

bit.ly/alex-js
ENSURE INCLUSIVE AND CLEAR LANGUAGE
48

bit.ly/write-good
49
Wow! Congratulations to Greg Gutfeld, a one time Trump Hater who has come all the
way home. His Ratings easily beat no talent Stephen Colbert, nice guy Jimmy
Fallon, and wacko “last placer” Jimmy Kimmel. Greg built his show from scratch,
and did a great job in doing so.
Well run States should not be bailing out poorly run States, using CoronaVirus as
the excuse! The elimination of Sanctuary Cities, Payroll Taxes, and perhaps
Capital Gains Taxes, must be put on the table. Also lawsuit indemnification &
business deductions for restaurants & ent.
Most of the money raised by the RINO losers of the so-called “Lincoln Project”,
goes into their own pockets. With what I’ve done on Judges, Taxes, Regulations,
Healthcare, the Military, Vets (Choice!) & protecting our great 2A, they should
love Trump. Problem is, I BEAT THEM ALL!
=============
he way home. His Ratings easily beat no talent Stephen Colbert, nice guy Jimmy F
^^^^^^
"easily" can weaken meaning on line 1 at column 104
-------------
hould not be bailing out poorly run States, using CoronaVirus as the excuse! The
^^^^^^
"poorly" can weaken meaning on line 3 at column 42
-------------
apital GainsTaxes, must be put on the table.Also lawsuit indemnification & bus
^^^^^^
"be put" may be passive voice on line 3 at column 184

50
bit.ly/hemingwayapp

HUMAN DOCUMENTATION
• Ensure visibility
51

Roads for Success Navigating Docs – Kyle Gillbit.ly/roads-docs
THINK TWICE ABOUT NAVIGATION
52

53

56
bit.ly/dashlane-ds

HUMAN DOCUMENTATION
• Ensure visibility
• Update it
57

UPDATE IT
58
bit.ly/dashlane-ds

UPDATE IT
59
https://bit.ly/template-pr

“Coding For Humans” by Paola Ducolin, Staff Engineer @ Dashlane

Recomendados

Recomendados

Mais conteúdo relacionado

Semelhante a “Coding For Humans” by Paola Ducolin, Staff Engineer @ Dashlane

Semelhante a “Coding For Humans” by Paola Ducolin, Staff Engineer @ Dashlane (20)

Mais de Paris Women in Machine Learning and Data Science

Mais de Paris Women in Machine Learning and Data Science (20)

Último

Último (20)

“Coding For Humans” by Paola Ducolin, Staff Engineer @ Dashlane