Home > Articles > Programming > Windows Programming

Robert C. Martin's Clean Code Tip of the Week #4: Avoid Obsolete Comments

We join "The Craftsman," Robert C. Martin's series on an interstellar spacecraft where programmers hone their coding skills. In this fourth tip in the series, the programmers examine the problem with obsolete comments, which tend to migrate away from the code they once described and become floating islands of irrelevance and misdirection.
You can review additional articles from Robert C. Martin's series, "The Craftsman," on the ObjectMentor website.
Like this article? We recommend

Jan 15, 1945, 14:22:00 GMT

Crewmen Yeager and O’Hare stood at the observation port and gazed out into the vast emptiness.  Crewing the massive Orion vessel, as she plied her way towards Clyde, was a demanding job; so times like these were few and far between.  From a distance of five million kilometers the Earth was a tiny crescent sapphire blazing amidst an impossibly starry background.  The brilliant white spark of Luna nestled nearby was too small for its crescent to be resolved.

Chuck and Butch were racing away from home at 4km/s toward a destination many months and many millions more kilometers away.  Though there were 18 other men aboard, the view out the portal left them feeling very, very alone.

Friday, 8 Mar 2002, 08:00

Yesterday’s session with Adelaide went pretty well.  She’s a bit nervous, but very smart.  I sat down with her again this morning for an hour or so.  We were working together on fixing a bug in an old module.  As we scrolled through this module on the screen I noted a strange comment above a stretch of code.


  // Slim sockets go from 9020-9025


 public String getCommandLine() {

    return slimCommand;



  public int getNextSlimSocket() {

    synchronized (slimSocketOffset) {

      int base = slimSocketOffset.get();


      if (base >= 10)

        base = 0;


      return base + 8085;




Adelaide scrolled right past that code, so I motioned for her to stop. 

“Did you see that?” I asked.

She kept her eyes on the screen and said: “See what?”

“That comment.”

“What comment?”

“You didn’t see it?”

She hung her head a little and then looked over at me.  “I usually don’t bother to read the comments when I’m skimming the code. “ She said.

“Yeah,” I said.  “What good are they if you don’t read them?  Scroll back a little.”

She winced, but waved her hand at the screen and the code scrolled back to where the comment was. 

“Oh!” She said.  “The comment is wrong! The ports go from 8085 to 8095.” 

I looked at her and said: “Not only that, it’s in the wrong place.  It looks like someone plopped that getCommandLine() function between the comment and the getNextSlimSocket) function.  I wonder how old that comment is.  Someone must have changed the code after the comment was written.”  I looked at her pointedly and said:  “Someone who didn’t read comments.”

She looked at me crossly, but then softened.

“We could look in the git logs” She offered “and see who did this and when.”

“There’s no point.” I said.  And I grabbed the keyboard and deleted the comment.

“Wait!  Why’d you do that?” She blurted.

“The comment wasn’t just wrong and misplaced,” I said.  “It was worthless.  The code tells us what’s really going on, and it’s pretty clear.”

She looked at me skeptically.  “Why do you think it’s worthless?  We can make it right.”

“Look,” I said.  “This code was modified at least twice, and both times the modifier ignored the comment.  In once case they separated the comment from the function it described.  In the second case they changed the algorithm to disagree with the comment.  Since nobody apparently bothered to read the comment, the comment must be useless.”

She shook her head and said: “I don’t get that. Once we fix it the comment will be right, and will help other people who read through this module.”

“Like it helped you?” I prodded?  “People don’t tend to read comment unless they are stuck.  If the code is understandable, like this code is, then they’ll just ignore the comment.  They’ll assume they know what it says.”

She scrunched up her shoulders and stared at the screen. 

“Fine.” She said. 

I sighed and brought up Clean Code rule C2 on the screen.

“See?” I said.  “It’s part of Mr. C’s rules.”

“He doesn’t say to delete it, he says to update it.”

“Actually, he says not to write a comment that will become obsolete. Since this comment became obsolete, it shouldn’t have been written.  So I deleted it.”

“You just don’t like comments.” She pouted.

I wasn’t getting anywhere this way.  I was about to shrug my shoulders and move on when I notice that Jean had moved in behind us and had been following the whole conversation.

“Goodness, Gracious, what a fuss!” She coddled.  “Dear Adelaide it’s good that you want to help other people read your code.  And comments can be a powerful way to help others.  But, my dear, I’m sorry to say that Alphonse is right in this case.  He’s such a fine young developer, just like you are dear.  You see, a comment’s true value is to clarify something that’s unclear.  If that thing is clear already, like the code you two have been bickering over, then the comment serves no good purpose and should be removed.”

Adelaide hung her head and nodded, but kept her eyes on her hands.

“Alphonse, dear,” Jean said.  “I’m sure you’ve got lots of your own work to do.  I’d like to spend some time working with Adelaide now.  Why don’t you find Avery and get him to help you?”

I thanked Jean and Adelaide, and wandered back to my workstation. 

“What was that all about?” I asked myself. 

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020