Code comments are your code autobiography - Speaker Deck

Tweet

Tweet

Slide 1

Slide 1 text

Code comments === Code autobiography

Slide 2

Slide 2 text

WHAT DO WE THINK ABOUT COMMENTS?

Slide 3

Slide 3 text

EAT. SLEEP. GRUMP. REPEAT

Slide 4

Slide 4 text

As a result

Slide 5

Slide 5 text

As a result

Slide 6

Slide 6 text

As a result OR

Slide 7

Slide 7 text

As a result OR

Slide 8

Slide 8 text

As a result

Slide 9

Slide 9 text

As a result

Slide 10

Slide 10 text

Code Comments as a contract

Slide 11

Slide 11 text

Code comments ⊂ clean code

Slide 12

Slide 12 text

Code comments ⊂ clean code

Slide 13

Slide 13 text

Code comments ⊂ clean code

Slide 14

Slide 14 text

Code comments ⊂ clean code

Slide 15

Slide 15 text

Code comments ⊂ clean code

Slide 16

Slide 16 text

Synthetic Example Obvious detailed

Slide 17

Slide 17 text

1. Code comments are coupled to the code itself 2. It is in the developer’s responsibility to update them too 3. Should be checked during a code review

Slide 18

Slide 18 text

Scope::Access modifiers The scope of the code is not relevant whether you should or shouldn’t put a comment on it

Slide 19

Slide 19 text

Reap the rewards of your work

Slide 20

Slide 20 text

Follow me