The Artima Developer Community
Sponsored Link

Agile Buzz Forum
To comment or not

0 replies on 1 page.

Welcome Guest
  Sign In

Go back to the topic listing  Back to Topic List Click to reply to this topic  Reply to this Topic Click to search messages in this forum  Search Forum Click for a threaded view of the topic  Threaded View   
Previous Topic   Next Topic
Flat View: This topic has 0 replies on 1 page
James Robertson

Posts: 29924
Nickname: jarober61
Registered: Jun, 2003

David Buck, Smalltalker at large
To comment or not Posted: Mar 8, 2006 7:41 AM
Reply to this message Reply

This post originated from an RSS feed registered with Agile Buzz by James Robertson.
Original Post: To comment or not
Feed Title: Cincom Smalltalk Blog - Smalltalk with Rants
Feed URL: http://www.cincomsmalltalk.com/rssBlog/rssBlogView.xml
Feed Description: James Robertson comments on Cincom Smalltalk, the Smalltalk development community, and IT trends and issues in general.
Latest Agile Buzz Posts
Latest Agile Buzz Posts by James Robertson
Latest Posts From Cincom Smalltalk Blog - Smalltalk with Rants

Advertisement

There's a long thread on whether to comment code in comp.lang.smalltalk - reading it, I think there's a bridge not being crossed by any of the proponents. The case for comments was made by Vassili on his blog here; read the cls thread, and you'll see plenty of the other side - this being a good example.

On the one hand, Vassili points out that comments are another form of communication between the current developer and future developers - and more communication is usually better than less. The caveat I have is the matter of bit rot. Over time, code gets changed for a variety of reasons. Maintenance, refactoring, what have you. The comments almost never keep up. What started out as a well intentioned comment with high communicative value often ends up as a misleading marker to the past. I have no idea how to fix that problem, either. The decisions to update code are made over a long period of time, and whether a given developer "has time" to muck with the comment is typically an ad-hoc decision.

Perhaps a development standard, taken on by the whole group would help. I don't know - if it were easy, that long winded cls discussion wouldn't be happening.

Read: To comment or not

Topic: Small Annoyance, Fixed Previous Topic   Next Topic Topic: MySQL on Mac OS X

Sponsored Links



Google
  Web Artima.com   

Copyright © 1996-2019 Artima, Inc. All Rights Reserved. - Privacy Policy - Terms of Use