What was the most refreshingly honest non-technical comment you saw in the code?

Posted by DVK on Stack Overflow See other posts from Stack Overflow or by DVK
Published on 2010-05-25T19:12:52Z Indexed on 2010/05/25 19:21 UTC
Read the original article Hit count: 231

Filed under:

subjective

|

comments

|

Maintenance

|

readability

OK, so we all saw the lists of "funny" or "bad" comments.

However, today, when maintaining an old stored proc, I stumbled upon a comment which I couldn't classify other than "refreshingly brutally honest", left by a previous maintainer around a really freakish (both performance and readability-wise) page-long query:

 -- Feel free to optimize this if you can understand what it means

So, in the first (and hopefully only) poll type question in my history of Stack Overflow, I'd like to hear some other "refreshingly brutally honest" code comments you encountered or written.

© Stack Overflow or respective owner

Related posts about subjective

Scoring/analysis of Subjective testing for skills assessment

as seen on Programmers - Search for 'Programmers'
I am lucky in the sense that I have been given the opportunity to be a 'Technical Troubleshooter' for our offshore development team. While I am confident and capable of dealing with most issues, I have come across something that I am not. Based on initial discussions with various team members both… >>> More
Best Practise/Subjective: Implement a finite state automaton in OOP

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi guys, I am thinking about implementing a programm with finite state automaton in an OOP language like Java or C++. What would you think is the best way to implement this with a manageable amount of available states, regarding to good software design? Is it good to implement for each state an… >>> More
Subjective question...would you use the Action delegate to avoid duplication of code?

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello, I just asked a question that helps about using generics (or polymorphism) to avoid duplication of code. I am really trying to follow the DRY principle. So I just ran into the following code... Sub OutputDataToExcel() OutputLine("Output DataBlocks", 1) OutputDataBlocks() … >>> More
"Best" language /architecture for browser-based app with ODBC and sockets? (subjective)

as seen on Stack Overflow - Search for 'Stack Overflow'
Sorry to ask a subjective question, but I would welcome some advice. I am an experienced programmer of embedded s/w, but haven't done much network programming, although I have done a fair bit of hobbyist PHP. Anyway, I have to develop what is probably a fairly general type of app, as shown in this… >>> More
The best terminal emulator for a heavy terminal user?

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
I spend a lot of time at the command-line during the workday and at home too since I run Ubuntu exclusively. I've been using the default gnome terminal but I've reached a point where I'd really like to get my terminal tricked out so that my common tasks are as easy as possible. Specifically, I find… >>> More

Related posts about comments

SQL Developer Data Modeler: On Notes, Comments, and Comments in RDBMS

as seen on Oracle Blogs - Search for 'Oracle Blogs'
Ah the beautiful data model. They say a picture is worth a 1,000 words. And then we have our diagrams, how many words are they worth? Our friends from the Human Relations sample schema So our models describe how the data ‘works’ – whether that be at a logical-business level, or a… >>> More
Comments on Comments

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
I almost tweeted a reply to Capar Kleijne's question about comments on Twitter, but realized that my opinion exceeded 140 characters. The following is based upon my experience with extremes and approaches that I find useful in code comments. There are a couple extremes that I've seen and reasons… >>> More
Comments in string and strings in comments

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi there, I am trying to count characters in comments included in C code using Python and Regex, but no success. I can erase strings first to get rid of comments in strings, but this will erase string in comments too and result will be bad ofc. Is there any chance to ask by using regex to not match… >>> More
checkins/recent not returning comments or even counts of comments

as seen on Stack Overflow - Search for 'Stack Overflow'
My application has been using the checkins/recent endpoint to show where all the current users friends are currently at and I had included a button the user could press to comment on a checkin. The button used to have the comment count on it until recently. It seems the checkins/recent endpoint no… >>> More
VS for Database Pros (GDR R2) Removes Sproc Comments (2 replies)

as seen on .NET 247 - Search for '.NET 247'
I have been working with my team to implement Data Dude GDR R2 for managing ALL of the databases for our applications. So far I am very pleased by what we can do with the tool with a single exception. I want to have a header with comments as part of every stored procedure so we can track the history… >>> More