3min chapter

CodeNewbie cover image

S21:E3 - Why learning good documentation skills is so important for leveling up (Eddie Hinkle)

CodeNewbie

CHAPTER

Code Comments - A Great Way to Make Your Code Clear

Documentation ends specifically in the context of making your code very clear, is an interesting problem. The biggest question is, who is your user for any particular ting? So if it is only fellow developers who are editing the code, then that's a great use forCode comments. If you have someone who needs to understand something, but they may not be in the actual source files,. That's when you want to create separate, actual documentation where people can actually access it and read it just by visiting a u or l.

00:00

Get the Snipd
podcast app

Unlock the knowledge in podcasts with the podcast player of the future.
App store bannerPlay store banner

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode

Save any
moment

Hear something you like? Tap your headphones to save it with AI-generated key takeaways

Share
& Export

Send highlights to Twitter, WhatsApp or export them to Notion, Readwise & more

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode