3 ms·
With respect to code documentation, I am self-taught, and use thorough documentation because I feel it both reinforces my intent and gives me the experience of
by injectJon 9y ago
With respect to code documentation, I am self-taught, and use thorough documentation because I feel it both reinforces my intent and gives me the experience of describing it to someone else. I get the benefits of teaching, while also sparing my S.O. hours of listening to me rant and rave about things she isn't interested in.
I dont have a mentor, so this has helped tremendously.
- mikekchar 9y agoThis is a good idea. One thing you might try is also to do the same thing with unit tests. Can someone discover the intent of the code from the tests? I have found this considerably trickier to do than it seems because there is a tendency to introduce a lot of noise with the tests in order to get good coverage. I personally found it illuminating to refactor the code and tests so that I get the same kind of coverage without the noise.