Tag Archives: comments

TODO Comments and Technical Debt

When I first started out in software development, I used to write a lot of comments in my code. To stay consistent with the developers who had previously worked on the same code, I even added to the historical comments above each module.

As a result, the top of a VB module could look like this:

' ****************************************
' Module: EmailProcessor
' Purpose: Process Email
' Author: John Doe
' Last Modified By: Jane Smith
' *****************************************
Sub ProcessEmail
  ' process email here
  Call ProcessEmail()
End Sub

Continue reading