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

• How to Crush an Interview
• https://youtu.be/bJ-U6bJGifA
• Avoid Else Return Early
• http://blog.timoxley.com/post/47041269194/avoid-else-return-early
• Ikea Algorithms
• https://idea-instructions.com/
• Playing Distributed Poker with Cryptography (Ron Rivest)
• https://www.youtube.com/watch?v=mthPiiCS24A

Book of the Show

• Jason: Hillbilly Elegy
• https://amzn.to/2EkJYsL
• Patrick: Oathbringer
• https://amzn.to/2H9lW72

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