Wednesday, April 4, 2018

Episode 76: Code Documentation

Download

We are sponsored by audible! http://www.audibletrial.com/programmingthrowdown

We are on Patreon! https://www.patreon.com/programmingthrowdown

T-Shirts! http://www.cafepress.com/programmingthrowdown/13590693

Intro

How to prepare for System Design & ML Design interviews.

News/Links

Book of the Show

Tool of the Show

  • Jason: iFunny/9GAG
  • Patrick: PUBG Mobile

Code Documentation (52:42)

  • Why Document?
    • More people will read code than write it.
    • Recover context on a piece of code quickly.
    • Avoid unexpected inputs
  • Vanilla code comments
    • At the top
    • At the line
  • Ways to self-document code
    • Function & Variable signatures
    • Extra scope around variables
    • Avoid variable reuse
    • (Sometimes) describe the type in the variable name
  • Generators
    • C/C++/Java
      • Doxygen
      • Javadocs
    • Python
      • Sphinx
    • Javascript
      • JSDoc

4 comments:

  1. Very well said, your blog says it all about that particular topic.”`”* https://royalcbd.com/how-to-make-cbd-gummies-at-home/

    ReplyDelete
  2. Hi, I do think this is a great web site. I stumbledupon it 😉
    I’m going to come back yet again since I book marked it. eid ul fitr messages

    ReplyDelete

  3. Thanks for sharing this.,
    Leanpitch provides crash course ,everyone can use it wisely.
    NLP training
    conflict management
    Servant Leadership

    ReplyDelete
  4. Hello I am so delighted I located your blog, I really located you by mistake, while I was watching on google for something else, Anyways I am here now and could just like to say thank for a tremendous post and a all round entertaining website.
    Do check
    Paypal Login
    gemini login

    ReplyDelete