Top 5 Ways To Document Your Code

Поделиться
HTML-код
  • Опубликовано: 24 янв 2025

Комментарии • 49

  • @kevingagnon4310
    @kevingagnon4310 Год назад +3

    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.

  • @emmanuelanthonyfermin7853
    @emmanuelanthonyfermin7853 2 года назад +10

    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
      @RedhwanNacef  2 года назад

      Great to hear it helped, thanks.

  • @alvaro8325
    @alvaro8325 2 года назад +5

    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
      @RedhwanNacef  2 года назад +1

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

  • @Hendrizzzz
    @Hendrizzzz 4 месяца назад

    I'm a 2nd year comsci student, and these tips are helpful. I learned that my code practice is bad (I should've refactored more so that the code is the documentation itself). I'll use these in my future works. Thank you!

  • @adreamer9999
    @adreamer9999 2 года назад +5

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

  • @Deserthacker
    @Deserthacker 3 года назад +6

    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
      @RedhwanNacef  2 года назад +1

      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.

  • @VickyMei
    @VickyMei 2 года назад +1

    really great video! thanks for sharing!

  • @user_ahfvppkjb
    @user_ahfvppkjb 3 года назад +1

    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
      @RedhwanNacef  3 года назад

      Thanks so much. Haha, good idea!

  • @kenttorres9465
    @kenttorres9465 8 месяцев назад

    This was very helpful, thank you!

  • @irinafanassenko
    @irinafanassenko 2 года назад +1

    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
      @RedhwanNacef  Год назад

      Thanks! Some useful links in the description. 😊

  • @ledigdev
    @ledigdev Год назад +1

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

    • @RedhwanNacef
      @RedhwanNacef  Год назад +1

      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.

    • @ledigdev
      @ledigdev Год назад +1

      @@RedhwanNacef thats make a lot of sense hahaha thanks

  • @tonyjaradev
    @tonyjaradev 3 года назад +1

    wonderful tips! subscribed!

  • @kiaracodes5166
    @kiaracodes5166 2 года назад +1

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

    • @RedhwanNacef
      @RedhwanNacef  2 года назад

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

  • @oladayoagbolade3676
    @oladayoagbolade3676 3 года назад +1

    Very underrated video

  • @josechirino5168
    @josechirino5168 3 года назад +1

    Great explanation, thanks

  • @keenanduplessis3023
    @keenanduplessis3023 3 года назад +1

    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
      @RedhwanNacef  3 года назад

      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!

  • @theMadZakuPilot
    @theMadZakuPilot Год назад +1

    thank you brother.

  • @brijeshkumarchavda
    @brijeshkumarchavda 3 года назад

    It's very helpful. Thank you very much.

  • @saadmansakib6612
    @saadmansakib6612 3 года назад +1

    Great video!

  • @l-Il.-._.-.lI-l
    @l-Il.-._.-.lI-l 3 года назад

    Great videos, keep it up!

  • @DavidTangye
    @DavidTangye Год назад +1

    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
      @RedhwanNacef  Год назад

      Thanks! Noted, thanks for the feedback.

  • @OJI3G
    @OJI3G 3 года назад +1

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

    • @RedhwanNacef
      @RedhwanNacef  3 года назад

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

  • @rhn8696
    @rhn8696 2 года назад +1

    thanks :D

  • @ferroalloys594
    @ferroalloys594 4 месяца назад

    If and iff, you must include "comments" then exclusively in, say, 'z' or 'vdm' otherwise please don't bother! Simples ):-)

  • @markcuello5
    @markcuello5 Год назад

    HELP