I spent this weekend at
No Fluff Just Stuff Chicago. I attended a variety of sessions and plan to blog about them over the next few weeks. (The conference also inspired me to blog here more. So, my first New Year's Resolution.)
There were 10 of us from
Orbtz there but I also saw some people from other jobs or just around town. One of them was from a client when I was a consultant.
Yesterday, I reintroduced myself to him. I could not remember his name and was happy his giant conference name tag was pointing out. However before I could say my name, he said "Jacob right?, I see you name now and then in the code."
I don't think this is good. I doubt my name is only preceded by @auther JavaDoc directives. I am guessing they see it often enough to remember my name 4 years later because I have added comments in the middle of JSPs, bean descriptors, and actions just before commented out code. We used CVS on this project, but I must not have learned to trust and use it like I do now with my SCM systems.
Today, I never add comments to code that would better be kept in source control. I also write code that is more self-documenting. Most of the comments I add now are JavaDocs. From time to time I have 'if (something really complicated ) { //This is what that does in English', but more and more that is refactored to a method that can be tested alone.
Tests, I think this might be the strongest type of comments I write now. Long English test method names grouped together to describe how a methods works and then proves to you it does (every time some one commits code!)
I wasn't completely surprised this guy remembered my name though. I have a way of infecting Tomaw into projects. When I started my first job at the company where a year earlier I had taken my last internship, many of my new coworkers were surprised to know that jtomaw was a real person. My user name had become the default user name that everyone logged in using. Perhaps after writing the log in mechanism but before providing instructions to log in, I should have written how to create a new user.
Labels: coding, nfjs, style