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
60
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
84
My capsule wardrobe experience
Avatar for Cheesecake Labs cheesecakelabs
3
59
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
商品比較サービス「マイベスト」における パーソナライズレコメンドの第一歩
Avatar for Ucchiii ucchiii43
0
180
AI時代のソフトウェア開発を考える（2025/07版） / Agentic Software Engineering Findy 2025-07 Edition
Avatar for Takuto Wada twada
PRO
99
37k
オンコール⼊⾨〜ページャーが鳴る前に、あなたが備えられること〜 / Before The Pager Rings
Avatar for Yuuki Takahashi yktakaha4
2
1k
バイブコーディング超えてバイブデプロイ〜CloudflareMCPで実現する、未来のアプリケーションデリバリー〜
Avatar for azukiazusa azukiazusa1
1
410
テスト駆動Kaggle
Avatar for ねぼすけAI isax1015
1
630
dbt民主化とLLMによる開発ブースト ~ AI Readyな分析サイクルを目指して ~
Avatar for yosh_yumyum yoshyum
3
1.1k
CDK引数設計道場100本ノック
Avatar for kazuho cryer-shinozuka badmintoncryer
2
480
なぜ「共通化」を考え、失敗を繰り返すのか
Avatar for Rinchoku rinchoku
1
680
チームのテスト力を総合的に鍛えて品質、スピード、レジリエンスを共立させる/Testing approach that improves quality, speed, and resilience
Avatar for Hiroki Iseri goyoki
5
1.1k
NPOでのDevinの活用
Avatar for みんなのコード codeforeveryone
0
900
[SRE NEXT] 複雑なシステムにおけるUser Journey SLOの導入
Avatar for yakenji yakenji
0
150
Claude Code派？Gemini CLI派？ みんなで比較LT会！_20250716
Avatar for じゅん junholee
1
540

Featured

See All Featured
Navigating Team Friction
Avatar for Lara Hogan lara
187
15k
Fantastic passwords and where to find them - at NoRuKo
Avatar for Phil Nash philnash
51
3.3k
GitHub's CSS Performance
Avatar for Jon Rohan jonrohan
1031
460k
What’s in a name? Adding method to the madness
Avatar for Product Marketing Alliance productmarketing
PRO
23
3.5k
10 Git Anti Patterns You Should be Aware of
Avatar for Lemi Orhan Ergin lemiorhan
PRO
656
60k
StorybookのUI Testing Handbookを読んだ
Avatar for Shingo Yamazaki zakiyama
30
5.9k
Facilitating Awesome Meetings
Avatar for Lara Hogan lara
54
6.5k
Building Adaptive Systems
Avatar for Chris Keathley keathley
43
2.7k
Visualization
Avatar for Eitan Lees eitanlees
146
16k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
Avatar for Michelle Schulp Hunt marktimemedia
31
2.4k
YesSQL, Process and Tooling at Scale
Avatar for Rocio Delgado rocio
173
14k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
Avatar for panda_program panda_program
108
19k

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