4 ms·
Could I make a request for an example of good documentation? Obviously this is hilarious, and for the most part "do the opposite" would work just fine; but a re
by erikwiffin 17y ago
Could I make a request for an example of good documentation?
Obviously this is hilarious, and for the most part "do the opposite" would work just fine; but a readable, friendly, best-practice "this is how you should document stuff" article would be appreciated.
- patio11 17y agoI always tell my Indians: Write all comments and code with an eye to them getting read in two years by a man you've never met who does not speak your language, has never heard of this project before, and needs to fix the bug that brought down the server in less than 2 hours or the boss will have his hindquarters. Because that is EXACTLY who will be reading this next. Compliance with this direction is... sporadic. / implement first business logic */ public void process() { ... }
- icefox 17y agoIf you were to send in your code to someone as sample code for a job interview would you need to change anything?