Its the new development methodology thats taking the developer-world by storm….
Well, not really.
Just a cute phrase that occurred to me today when chatting to a colleague. We’d just spent 15 minutes discussing the desired behaviour of a system I was working on. Usual stuff – at first blush it seems straightforward, but plenty of edge cases, historical behaviour requirements, and other nastiness.
So we got it figured out, and its 11:45. Lunch booked at 12:00. No way am I even getting 10% of the code done in that time. But its just enough time to do the Javadoc.
So, 15 minutes later, my code has the 2 method signatures I need and around 40 lines of Javadoc describing the code’s behaviour, exceptions, and assertions. And after lunch, I was able to get straight into coding, all details of my discussion safely preserved.
And as an added bonus, when it comes time to rework it, I (or the next guy) will have some great doco to get started.
Not rocket science. Certainly not worthy of its own buzzword-esque title (although it does roll off the tongue
). And probably something everybody should be doing anyway as part of their actual methodology. But its a neat little anecdote worth telling!