On Tue, Apr 14, 2009 at 4:56 PM, Ryan Waterer <[email protected]>wrote:
> In my experience, some developers are more concerned about their quantity > of > code output. These developers are usually too busy to explain the what, > the how > or the why anywhere -- not in the javadoc, not in the checkin comments, not > in any > documentation, and not in comments. As such, these developers code is > generally much more difficult to maintain. > > Now, I'm not saying that I don't have the ability to generate complete WTF > code > at times -- I just try to take extra steps to help my code maintainable. > There are > many times where I've taken 2 minutes to put a little extra comments in the > JavaDoc, the checkin comments, or an inline comment that mentions the why > and what to avoid that has saved me at a later date. > > (Queue music and thoughts of days spent "fixing" my code and falling into a > trap > that I didn't recall already hitting and solving until I had gone through > it again) This situation is partly solved with using a "better" ALM. Using topic-branches with a mandatory review before code gets pulled into mainline usually gets the job done. > > > On Tue, Apr 14, 2009 at 7:13 AM, Dominic Mitchell > <[email protected]>wrote: > >> >> On Tue, Apr 14, 2009 at 06:07:54AM -0700, Reinier Zwitserloot wrote: >> > >> > The staunch refusal of most VCSes to not allow you to entire an empty >> > commit is actually a mistake, I think. For example, git commit will >> > abort the commit if you leave the message blank. For sufficiently >> > small commits, the VCS should just cook up a message based on the >> > diff. The 'why' is not always relevant (e.g. if you fix a typo, I >> > could say "I fixed a typo", but that's obvious from the diff, and I >> > could also say "typos are -duh- stuff that needs fixing", but that's >> > obvious). >> >> Oh, I'd agree that a typo fix probably warrants no more than a "typo" >> message. But most people don't seem to understand that checking in >> 3,000 lines of diff with nothing more than "fixes customer bug" is not >> terribly helpful. >> >> -Dom >> >> >> > > > > -- Viktor Klang Senior Systems Analyst --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "The Java Posse" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/javaposse?hl=en -~----------~----~----~----~------~----~------~--~---
