Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Document your code

Avatar for Cheesecake Labs Cheesecake Labs
August 30, 2018
Programming
0
42

Document your code

Ilê Caian
Avatar for Cheesecake Labs

Cheesecake Labs

August 30, 2018
Tweet

More Decks by Cheesecake Labs

See All by Cheesecake Labs
Cats' wellness & care
Avatar for Cheesecake Labs cheesecakelabs
0
49
How do we create the first impressions?
Avatar for Cheesecake Labs cheesecakelabs
0
53
Menstrual cup: suit and freedom
Avatar for Cheesecake Labs cheesecakelabs
0
57
Life is a cycle, better with a bicycle
Avatar for Cheesecake Labs cheesecakelabs
0
51
Interview Process: how to get the best of people
Avatar for Cheesecake Labs cheesecakelabs
1
81
My capsule wardrobe experience
Avatar for Cheesecake Labs cheesecakelabs
3
58
Stonewall Rebellion and its impact on LGBTQIA+ history
Avatar for Cheesecake Labs cheesecakelabs
1
37
Pregnancy, childbirth and breastfeeding: What do I have to do with it?
Avatar for Cheesecake Labs cheesecakelabs
0
45
MBTI - Psychological types described by Jung
Avatar for Cheesecake Labs cheesecakelabs
0
130

Other Decks in Programming

See All in Programming
来たるべき 8.0 に備えて React 19 新機能と React Router 固有機能の取捨選択とすり合わせを考える
Avatar for Yuka O’oka oukayuka
2
820
すべてのコンテキストを、 ユーザー価値に変える
Avatar for Michiru Kato applism118
2
430
複数アプリケーションを育てていくための共通化戦略
Avatar for irof irof
10
4k
なぜ「共通化」を考え、失敗を繰り返すのか
Avatar for Rinchoku rinchoku
1
360
Enterprise Web App. Development (2): Version Control Tool Training Ver. 5.1
Avatar for Koichi NAKAGAWA knakagawa
1
120
事業戦略を理解してソフトウェアを設計する
Avatar for 増田 亨 masuda220
PRO
22
6.2k
統一感のある Go コードを生成 AI の力で手にいれる
Avatar for Kotaro Otaka otakakot
0
3k
AIコーディング道場勉強会#2 君（エンジニア）たちはどう生きるか
Avatar for misaki.otb misakiotb
1
240
Team topologies and the microservice architecture: a synergistic relationship
Avatar for Chris Richardson cer
PRO
0
920
「Cursor/Devin全社導入の理想と現実」のその後
Avatar for Ryoichi Saito saitoryc
0
100
『自分のデータだけ見せたい！』を叶える──Laravel × Casbin で複雑権限をスッキリ解きほぐす 25 分
Avatar for AkitoTsukahara akitotsukahara
1
310
Create a website using Spatial Web
Avatar for Akio Itaya akkeylab
0
290

Featured

See All Featured
Building Adaptive Systems
Avatar for Chris Keathley keathley
43
2.6k
Rebuilding a faster, lazier Slack
Avatar for samanthasiow samanthasiow
81
9k
The Power of CSS Pseudo Elements
Avatar for Geoffrey Crofte geoffreycrofte
77
5.8k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
Avatar for Addy Osmani addyosmani
7
700
How to Think Like a Performance Engineer
Avatar for Harry Roberts csswizardry
24
1.7k
Code Review Best Practice
Avatar for Trisha Gee trishagee
68
18k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
Avatar for Marc Duiker marcduiker
30
2.1k
Navigating Team Friction
Avatar for Lara Hogan lara
187
15k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
Avatar for soudai sone soudai
PRO
181
53k
The Cost Of JavaScript in 2023
Avatar for Addy Osmani addyosmani
51
8.4k
10 Git Anti Patterns You Should be Aware of
Avatar for Lemi Orhan Ergin lemiorhan
PRO
657
60k
The Art of Delivering Value - GDevCon NA Keynote
Avatar for David Neal reverentgeek
15
1.5k

Transcript

  1. None

  2. Document Your Code With VSCode

  3. • Future Developers • Readability of questionable produced code •

    Decipher 'Magic Functions' Why?
  4. None

  5. But HOW?

  6. • Write readable code • SOLID principles How?

  7. Single Responsibility Principle

  8. Open/Closed Principle

  9. Liskov Substitution Principle

  10. Interface Segregation Principle

  11. Dependency Inversion Principle

  12. "The best kind of comments are the ones you don't

    need" -- Gandalf (https://blog.codinghorror.com/code-tells-you-how-co mments-tell-you-why/) Keep in mind
  13. None