Re:How should i document my code?
by jonloldrup on Sunday January 29, 2017 @07:54PM
(#13517857)
This sounds like a good suggestion.
Now my thought is to pair code files with similarly named doc files. Higher level code files will go first, and only later will I fill in the nitty gritty files.
The next question is: how do I get a good work flow? Due to a handicap, I am limited in my computer keyboard typing, but not limited in typing on my phone. Thus the optimal would be to find an Android markdown editor and an android git client. I'll check out the Play store :)
So, document things like "What are the big conceptual pieces of my project?", "How does data flow around?", "If a user sees <X>, what's behind it?".
Then, if you feel it needful, dig down into function-level and deeper stuff.