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
69
How do we create the first impressions?
Avatar for Cheesecake Labs cheesecakelabs
0
75
Menstrual cup: suit and freedom
Avatar for Cheesecake Labs cheesecakelabs
0
92
Life is a cycle, better with a bicycle
Avatar for Cheesecake Labs cheesecakelabs
0
75
Interview Process: how to get the best of people
Avatar for Cheesecake Labs cheesecakelabs
1
120
My capsule wardrobe experience
Avatar for Cheesecake Labs cheesecakelabs
3
82
Stonewall Rebellion and its impact on LGBTQIA+ history
Avatar for Cheesecake Labs cheesecakelabs
1
63
Pregnancy, childbirth and breastfeeding: What do I have to do with it?
Avatar for Cheesecake Labs cheesecakelabs
0
64
MBTI - Psychological types described by Jung
Avatar for Cheesecake Labs cheesecakelabs
0
160

Other Decks in Programming

See All in Programming
Import assertionsが消えた日～ECMAScriptの仕様はどう決まり、なぜ覆るのか～
Avatar for おおいし bicstone
2
180
AI時代になぜ書くのか
Avatar for Mutz mutsumix
0
250
Are We Really Coding 10× Faster with AI?
Avatar for Koichi Yoshida kohzas
0
130
Agentic Elixir
Avatar for Andrea Leopardi whatyouhide
0
440
ハーネスエンジニアリングとは？
Avatar for kinopee kinopeee
13
6.8k
サプライチェーン攻撃対策「層を重ねて落ちない壁」を10日間で組み上げた話 #TechLeadConf2026
Avatar for Kashun Yoshida kashewnuts
1
230
認証統合から始めるフロントエンドの機能単位開発 — マイクロサービス思想の適用
Avatar for kouki.miura koukimiura
0
100
SREに優しいTerraform構成 modulesとstateの組み方
Avatar for hiyanger hiyanger
2
170
エラー処理の温故知新 / history of error handling technic
Avatar for nakaryo ryotanakaya
7
1.8k
ふにゃっとしない名前の付け方 〜哲学で茹で上げる、コシのあるソフトウェア設計〜
Avatar for akshimo shimomura
0
110
Agentic UI in the Frontend: Architectures with Open Standards @JAX 2026 in Mainz
Avatar for Manfred Steyer manfredsteyer
PRO
0
100
Kubernetesを使わない環境にもCloud Nativeなデプロイを実現する / Enabling Cloud Native deployments without the complexity of Kubernetes
Avatar for linyows linyows
3
330

Featured

See All Featured
Navigating Algorithm Shifts & AI Overviews - #SMXNext
Avatar for Aleyda Solis aleyda
1
1.2k
Put a Button on it: Removing Barriers to Going Fast.
Avatar for kastner kastner
60
4.3k
The AI Revolution Will Not Be Monopolized: How open-source beats economies of scale, even for LLMs
Avatar for Ines Montani inesmontani
PRO
3
3.4k
Done Done
Avatar for chrislema chrislema
186
16k
brightonSEO & MeasureFest 2025 - Christian Goodrich - Winning strategies for Black Friday CRO & PPC
Avatar for Christian Goodrich cargoodrich
3
690
Documentation Writing (for coders)
Avatar for Carmen Chung carmenintech
77
5.3k
WCS-LA-2024
Avatar for Leonardo Collado-Torres lcolladotor
0
580
The Art of Delivering Value - GDevCon NA Keynote
Avatar for David Neal reverentgeek
16
1.9k
Building a Scalable Design System with Sketch
Avatar for Laura Van Doore lauravandoore
463
34k
The untapped power of vector embeddings
Avatar for Frank van Dijk frankvandijk
2
1.7k
How To Stay Up To Date on Web Technology
Avatar for Chris Coyier chriscoyier
790
250k
Designing Experiences People Love
Avatar for Jonathan Moore moore
143
24k

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