Anybody have any tips on documenting?
2 09 Dec 2016 04:40 by u/canus_lupus
I'm trying to flush out some of my simpler scripts into a simple tutorial along the lines of 'learn some linux command line basics and get free internet'.
(Seriously, i've been stealing internet for two years.)
The only trouble i'm having is laying down proper uniform documentation. I'm unfortunately not very consistent. Any tips?
10 comments
1 u/vaginitis20161116 09 Dec 2016 12:31
document anything non-obvious from the code itself. document non-idiomatic constructions. document uncommon dependencies. don't over-document.
0 u/TH3_1D10T 09 Dec 2016 04:43
Block comments before each big block of code, so that you don't have to list all the small stuff.
Tabed out comments that line up at a certain point for each bigroup single line piece of code. All single lines should line up with eachother, but no be annoying to read, so keep it smallish.
If you want it to be a tutorial, remember that small things are big at first, and gradually move upwards.
0 u/DrBunsen 09 Dec 2016 09:26
Do you hack WEP passwords, use unprotected internet points or do you do something else? Stealing sounds like you are doing things you are not supposed to be doing.