Is there any way to automatically wrap comments at the 80-column boundary as you type them? ..or failing that, any way to display a faint line at the coulmn 80 boundary to make wrapping them manually a little easier? Several other IDEs I use have one or other of those functions and it makes writing comments that wrap in sensible places ...
I have seen the other questions but I am still not satisfied with the way this subject is covered. I would like to extract a distiled list of things to check on comments at a code inspection. I am sure people will say things that will just cancel each other. But hey, maybe we can build a list for each camp. For the guys who don't comm...
We all know that commenting our code is an important part of coding style for making our code understandable to the next person who comes along, or even ourselves in 6 months or so. However, sometimes a comment just doesn't cut the mustard. I'm not talking about obvious jokes or vented frustraton, I'm talking about comments that appear...
What are good arguments to convince others to comment their code? I notice many programmers favor the perceived speed of writing code without comments over leaving some documentation for themselves and others. When I try to convince them I get to hear half baked stuff like "the method/class name should say what it does" etc. What woul...
One of the known problems with //TODO comments is that they tend to get "lost in the code" and are often never returned to. One usually finds them when searching the source code, or when actually going through the IDE task list (e.g., in Eclipse). Of course, bug reports are easier to find, but research shows that developers aren't rea...
What are your "favourite" overuses / misconceptions about commenting the code? Why do you sometimes think commenting is a pain? What arguments would you use to convince others that less is more at commenting in some cases? This is the negative counterpart to How to convince people to comment their code - such that it remains a collecti...
Hello everybody! Today I had an argument with a colleague about one of his comments as summary of a method. Mostly he is not writing any summaries but in this case he added one and it was a really bad one: It was not described what the method is doing, it assumed what the method maybe is doing. I have to add that this piece of code was ...
I first realized I sucked at commenting code when I was going back to old project and found complete classes and methods uncommented, knowing what the code did wasn't as hard but why it did it. So now I always write a short comment about how and why it does it. It is more for my own sake than for others. ...
i have a wordpress blog and want to give people the same user experience for adding comments that is in stackoverflow. There are a number of comments ajax plugins out there but i can't find a working one that allows you to inline on the main page, go in and add comments without first drilling down into a seperate single post page. Can ...
Is it possible to add comments somehow, somewhere? I don't pretend to be any sort of expert when using MySQL and certainly don't spend all day in it. More often than I would like I forget how I intend to use a column (usally the bit ones) and would be very excited if I could add a comment to remind me if 1 is good or bad, for example...
I'm really just curious, but if someone wants to make an argument that one is better than another - go for it! These are comments for example of writing style only, not meant to be judged by their content!.... First Person "I" comments: //i'm setting this to 1 because it breaks otherwise First Person "we" comments: //we need to se...
I have a colleague who insists that his code doesn't need comments, it's "self documenting." I've reviewed his code, and while it's clearer than code which I've seen others produce, I still disagree that self-documenting code is as complete and useful as well commented and documented code. Help me understand his point of view. What i...
I'd like to have comments in my code, but I want them to be removed before deploying. Yes, it's not hard to write such a thing, but if it already exists… And how about comments in ASP pages? ...
For example in C# or in JavaScript documents. If not, is there point in using Javadoc comments in ASP.NET programming? ...
function Submit_click() { if (!bValidateFields()) return; } function bValidateFields() { /// <summary>Validation rules</summary> /// <returns>Boolean</returns> ... } So, when I type the call to my bValidateFields() function intellisence in Visual Studio doesn't show my comments. But according to this it should. Should it? ...
How can I comment a JSP expression like: <%= map.size() %> Is there something like <%= // map.size() %>? ...
I'm looking for Python code that removes C and C++ comments from a string. (Assume the string contains an entire C source file.) I realize that I could .match() substrings with a Regex, but that doesn't solve nesting /*, or having a // inside a /* */. Ideally, I would prefer a non-naive implementation that properly handles awkward case...
English is not my mother tongue. However, I have to write comments in english. I want to improve my "comment english" by studying a piece of code which is commented in a good english. Please recommend an open source project which contains a lot of meaningful comments written by people with an excellent command of the language. ...
It is necessary to put copyright information and some other stuff on top of every source file in large enterprise projects. What is your preferred template, what should be included/excluded? I am more or less thinking of this: /** * This file is part of blabla. * Created: * Changes: * * * * $Id$ * Copyright (C) YEARS BlaB Com...
Is there an outlining setting to disable 'collapsing to definition' of comments in Visual Studio 2005? ...