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
51
0

Document your code

Ilê Caian

Avatar for Cheesecake Labs

Cheesecake Labs

August 30, 2018

More Decks by Cheesecake Labs

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

Other Decks in Programming

See All in Programming
エンジニアにデザインハーネスを 〜デザインプロセスを規定するためのハーネス〜 / Design harness from an engineer's perspective
Avatar for r-kagaya rkaga
2
1.3k
使用 Meilisearch 建立新聞搜尋工具
Avatar for johnroyer johnroyer
0
120
例外の正しい扱い方 そのエラー try-catchして大丈夫？
Avatar for Watanabe Jin jinwatanabe
0
360
Contextとはなにか
Avatar for chiroruxx chiroruxx
1
390
AI 輔助遺留系統現代化的經驗分享
Avatar for James Wang jame2408
1
1.2k
共通化で考えるべきは、実装より公開する型だった
Avatar for code-egg codeegg
0
190
AI がコードを書く時代における新卒エンジニアの仕事風景 (2026) / New Graduate Engineers in the Era of AI Coding (2026)
Avatar for sushichan044 sushichan044
0
210
信頼性について考えてみる（SRE NEXT 2026 miniLT）
Avatar for hayama hayama17
0
100
TSKaigi Night Talks 2026_TypeScriptでサプライチェーンの整合性を型に閉じ込める
Avatar for ギークプラス ソフトウェア事業部 geekplus_tech
0
440
スマートグラスで並列バイブコーディング
Avatar for Hayami Shuhei hyshu
0
280
技術記事、 専門家としてのプログラマ、 言語化
Avatar for Koutarou Chikuba mizchi
14
7.4k
20260623_Loop Engineeringで自分の分身の問い合わせBotを作る
Avatar for ryugen04 ryugen04
0
190

Featured

See All Featured
The browser strikes back
Avatar for Jono Alderson jonoalderson
0
1.4k
Done Done
Avatar for chrislema chrislema
186
16k
A designer walks into a library…
Avatar for Paul Jervis Heath pauljervisheath
211
24k
AI Search:
Where Are We & What Can We Do About It?
Avatar for Aleyda Solis aleyda
0
7.7k
Designing for humans not robots
Avatar for Tammie Lister tammielis
254
26k
How to build an LLM SEO readiness audit: a practical framework
Avatar for Nick Samuel nmsamuel
1
800
Taking LLMs out of the black box: A practical guide to human-in-the-loop distillation
Avatar for Ines Montani inesmontani
PRO
3
2.3k
Statistics for Hackers
Avatar for Jake VanderPlas jakevdp
799
230k
B2B Lead Gen: Tactics, Traps & Triumph
Avatar for Sophie Logan marketingsoph
0
170
Designing Dashboards & Data Visualisations in Web Apps
Avatar for Des Traynor destraynor
231
55k
The Director’s Chair: Orchestrating AI for Truly Effective Learning
Avatar for Mike Taylor tmiket
1
210
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
Avatar for Eileen M. Uchitelle eileencodes
28
3.6k

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