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

Document your code

Sponsored · Your Podcast. Everywhere. Effortlessly. Share. Educate. Inspire. Entertain. You do you. We'll handle the rest. →
Avatar for Cheesecake Labs Cheesecake Labs
August 30, 2018
Programming
0
46

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

Other Decks in Programming

See All in Programming
なるべく楽してバックエンドに型をつけたい！(楽とは言ってない)
Avatar for HIBIKI CUBE hibiki_cube
0
140
IFSによる形状設計／デモシーンの魅力 @ 慶應大学SFC
Avatar for がむ gam0022
1
300
Vibe Coding - AI 驅動的軟體開發
Avatar for Micky Li mickyp100
0
170
そのAIレビュー、レビューしてますか？ / Are you reviewing those AI reviews?
Avatar for r-kagaya rkaga
6
4.5k
20260127_試行錯誤の結晶を1冊に。著者が解説 先輩データサイエンティストからの指南書 / author's_commentary_ds_instructions_guide
Avatar for nash_efp nash_efp
0
890
OSSとなったswift-buildで Xcodeのビルドを差し替えられるため 自分でXcodeを直せる時代になっている ダイアモンド問題編
Avatar for yimajo yimajo
3
600
[KNOTS 2026登壇資料]AIで拡張‧交差する プロダクト開発のプロセス および携わるメンバーの役割
Avatar for hisatake hisatake
0
250
CSC307 Lecture 08
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
670
Amazon Bedrockを活用したRAGの品質管理パイプライン構築
Avatar for とすり tosuri13
4
240
humanlayerのブログから学ぶ、良いCLAUDE.mdの書き方
Avatar for Yuto tsukamoto1783
0
180
Package Management Learnings from Homebrew
Avatar for Mike McQuaid mikemcquaid
0
200
FOSDEM 2026: STUNMESH-go: Building P2P WireGuard Mesh Without Self-Hosted Infrastructure
Avatar for Date Huang tjjh89017
0
150

Featured

See All Featured
Writing Fast Ruby
Avatar for Erik Berlin sferik
630
62k
Everyday Curiosity
Avatar for Cassini Nazir cassininazir
0
130
Measuring & Analyzing Core Web Vitals
Avatar for Philip Tellis bluesmoon
9
750
Unlocking the hidden potential of vector embeddings in international SEO
Avatar for Frank van Dijk frankvandijk
0
170
Agile Leadership in an Agile Organization
Avatar for Dr. Kim W Petersen kimpetersen
PRO
0
79
DevOps and Value Stream Thinking: Enabling flow, efficiency and business value
Avatar for Helen Beal helenjbeal
1
89
The Curious Case for Waylosing
Avatar for Cassini Nazir cassininazir
0
230
GraphQLとの向き合い方2022年版
Avatar for Yosuke Kurami quramy
50
14k
Building Better People: How to give real-time feedback that sticks.
Avatar for Will Jessup wjessup
370
20k
Leading Effective Engineering Teams in the AI Era
Avatar for Addy Osmani addyosmani
9
1.6k
Docker and Python
Avatar for Tania Allard trallard
47
3.7k
Build your cross-platform service in a week with App Engine
Avatar for Jose L jlugia
234
18k

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