Top 5 Ways To Document Your Code

Hey! Today we are looking at the top ways to document your code. Hope you enjoy!
Useful Links:
Github: github.com/redhwannacef/youtu...
How to write a git commit: chris.beams.io/posts/git-commit/
Some code samples: ncrcoe.gitbooks.io/java-for-s...
Timestamps:
00:00 - Intro
01:01 - 1. Code
04:07 - 2. Comments
07:17 - 3. Tests
09:48 - 4. Git Commit Log
11:50 - 5. Readme
13:04 - Thank you for watching!
Music:
• Suburban
Huge thank you to Harris Heller for providing copyright-free music.
Attribution: Icons in thumbnail from www.flaticon.com/
------------------------
Hey everyone! My name is Redhwan Nacef (Red for short). In this channel, I'm hoping to share my thoughts on software engineering, coding, management, and all things tech. I hope you enjoy!

[@emmanuelanthonyfermin7853]

You know this is the methodology that I'm looking for, it's simple and full of insights. Very nice presentation. I've learned a lot

[@RedhwanNacef]

Great to hear it helped, thanks.

[@kevingagnon4310]

I love how, when you explained when to use comments in code, after applying previous tricks, the need of the comment became really irrelevant. It is possible to write self documenting code and you proved it. Thank you.

[@RedhwanNacef]

Thanks, glad you enjoyed it!

[@alvaro8325]

Thank you so much for this video. I'm starting the final project of my current semester and I need to have the documentation on point. Keep the great work!

[@RedhwanNacef]

Glad you enjoyed it. All the best with the semester, hopefully you’ll smash it!

[@kenttorres9465]

This was very helpful, thank you!

[@user_ahfvppkjb]

Very very helpful info, you made it so simple. Great job.
The first thing I am going to do is documenting this video :)
Thank you for your time.

[@RedhwanNacef]

Thanks so much. Haha, good idea!

[@adreamer9999]

Great video! Your explanations were concise and easy to understand. Excellent job and and thank you for speaking on this important and helpful subject.

[@RedhwanNacef]

Thanks for the great feedback.

[@VickyMei]

really great video! thanks for sharing!

[@RedhwanNacef]

Glad you enjoyed it!

[@iambrijeshtoo]

It's very helpful. Thank you very much.

[@RedhwanNacef]

Thanks! Happy it helped.

[@tonyjaradev]

wonderful tips! subscribed!

[@RedhwanNacef]

Thanks! 😊

[@josechirino5168]

Great explanation, thanks

[@RedhwanNacef]

Glad it was helpful!

[@l-Il.-._.-.lI-l]

Great videos, keep it up!

[@RedhwanNacef]

Thanks a lot, I will do!

[@keenanduplessis3023]

Thank you so much, this was really helpful. I'm not sure if this is something important to you but it was a little difficult for me to follow you because of how fast you were talking. I was able to understand because of the good examples you gave. Otherwise thanks again :)

[@RedhwanNacef]

You're very welcome, I'm glad it helped. Yes that is important as it helps me improve in future, thank you for the feedback!

[@saadmansakib6612]

Great video!

[@RedhwanNacef]

Thanks!

[@Deserthacker]

Amazing video and thanks for the tips! Two notes: I would call the function "requiresRootPrivileges" rather than "hasRootPrivileges" which should make what it does even more obvious. And secondly, I think you accidentally inverted your conditions in the "even better" and "even even better" code pieces around 7:00 or am I missing something?

[@RedhwanNacef]

Glad you enjoyed it. Yes thats a good suggestion, makes sense. Yes great spot! Silly mistake, I think the context/idea behind the point hopefully still makes sense.

[@kiaracodes5166]

This was very helpful! Do you have tool recommendations to use if we want to create a diagram of the project?

[@RedhwanNacef]

Glad it helped! I am still searching for the best tool, nowadays I like to use Excalidraw.

[@oladayoagbolade3676]

Very underrated video

[@RedhwanNacef]

Thanks!

[@irinafanassenko]

lot's of nice tips and good practice, Thanks! could you please share some tools or io sites that might help with code documentation?

[@RedhwanNacef]

Thanks! Some useful links in the description. 😊

[@theMadZakuPilot]

thank you brother.

[@RedhwanNacef]

You're welcome

[@michelledigdecarvalhoperei144]

what did you do to show up the markdown parts as you follow the video? like a slide? awesome vid

[@RedhwanNacef]

Glad you liked it. This is all done in my IDE, so I wrote out all points, then deleted them line by line, then I just press undo (cmd + z) on my keyboard and it adds them in.

[@michelledigdecarvalhoperei144]

@@RedhwanNacef thats make a lot of sense hahaha thanks

[@DavidTangye]

Good content, but would be much better if you had your screen zoomed in so I can see the code and text examples from my phone.

[@RedhwanNacef]

Thanks! Noted, thanks for the feedback.

[@rhn8696]

thanks :D

[@RedhwanNacef]

No problem!

[@user-vv9gf6dg9f]

Nice examples here. So sad I don't have enough skills to understand English language when it comes to that furious speed

[@RedhwanNacef]

Thanks. Ah I see, I will try to be more clear in future (I have a tendency to talk fast)!

[@markcuello5]

HELP

[@RedhwanNacef]

With what?