Top 5 Ways To Document Your Code

2024 ж. 18 Мам.

46 812 Рет қаралды

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!

Пікірлер

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
@emmanuelanthonyfermin78532 жыл бұрын
- Great to hear it helped, thanks.
  @RedhwanNacef2 жыл бұрын
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.
@kevingagnon4310 Жыл бұрын
- Thanks, glad you enjoyed it!
  @RedhwanNacef10 ай бұрын
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!
@alvaro83252 жыл бұрын
- Glad you enjoyed it. All the best with the semester, hopefully you’ll smash it!
  @RedhwanNacef Жыл бұрын
really great video! thanks for sharing!
@VickyMei2 жыл бұрын
- Glad you enjoyed it!
  @RedhwanNacef2 жыл бұрын
Great video! Your explanations were concise and easy to understand. Excellent job and and thank you for speaking on this important and helpful subject.
@adreamer99992 жыл бұрын
- Thanks for the great feedback.
  @RedhwanNacef2 жыл бұрын
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.
@user_ahfvjjfb2 жыл бұрын
- Thanks so much. Haha, good idea!
  @RedhwanNacef2 жыл бұрын
It's very helpful. Thank you very much.
@iambrijeshtoo2 жыл бұрын
- Thanks! Happy it helped.
  @RedhwanNacef2 жыл бұрын
Great explanation, thanks
@josechirino51682 жыл бұрын
- Glad it was helpful!
  @RedhwanNacef2 жыл бұрын
wonderful tips! subscribed!
@tonyjaradev2 жыл бұрын
- Thanks! 😊
  @RedhwanNacef2 жыл бұрын
Great videos, keep it up!
@l-Il.-._.-.lI-l2 жыл бұрын
- Thanks a lot, I will do!
  @RedhwanNacef2 жыл бұрын
Great video!
@saadmansakib66122 жыл бұрын
- Thanks!
  @RedhwanNacef2 жыл бұрын
thank you brother.
@theMadZakuPilot Жыл бұрын
- You're welcome
  @RedhwanNacef10 ай бұрын
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 :)
@keenanduplessis30232 жыл бұрын
- 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!
  @RedhwanNacef2 жыл бұрын
This was very helpful! Do you have tool recommendations to use if we want to create a diagram of the project?
@kiaracodes51662 жыл бұрын
- Glad it helped! I am still searching for the best tool, nowadays I like to use Excalidraw.
  @RedhwanNacef2 жыл бұрын
Very underrated video
@oladayoagbolade36762 жыл бұрын
- Thanks!
  @RedhwanNacef2 жыл бұрын
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?
@Deserthacker2 жыл бұрын
- 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.
  @RedhwanNacef2 жыл бұрын
lot's of nice tips and good practice, Thanks! could you please share some tools or io sites that might help with code documentation?
@irinafanassenko Жыл бұрын
- Thanks! Some useful links in the description. 😊
  @RedhwanNacef10 ай бұрын
thanks :D
@rhn8696 Жыл бұрын
- No problem!
  @RedhwanNacef Жыл бұрын
what did you do to show up the markdown parts as you follow the video? like a slide? awesome vid
@michelledigdecarvalhoperei14410 ай бұрын
- 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.
  @RedhwanNacef10 ай бұрын
- @@RedhwanNacef thats make a lot of sense hahaha thanks
  @michelledigdecarvalhoperei14410 ай бұрын
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.
@DavidTangye10 ай бұрын
- Thanks! Noted, thanks for the feedback.
  @RedhwanNacef10 ай бұрын
Nice examples here. So sad I don't have enough skills to understand English language when it comes to that furious speed
@user-vv9gf6dg9f2 жыл бұрын
- Thanks. Ah I see, I will try to be more clear in future (I have a tendency to talk fast)!
  @RedhwanNacef2 жыл бұрын
HELP
@markcuello5 Жыл бұрын
- With what?
  @RedhwanNacef10 ай бұрын