IDE poll
-
Getting some people to add XML comments to methods is hard enough - can you imaging just what pictures some people are going to attach to their code? X| I'll give it a miss, thanks.
Bad command or file name. Bad, bad command! Sit! Stay! Staaaay...
-
That's not a real argument is it? :-D Question is, if it was available, would you use it. Don't shift responsibility to someone else now ;P .
V.
(MQOTD rules and previous solutions)Think of it this way: if you could post images in the Lounge, I probably would. But...so would spammers, viagra salesmen, trolls, and general morons. Which is why we don't have it! And do you really want your source code to expand that much? My backups are big enough as it is, without potentially adding an image per line of code (or even per method). You and I both know that if you can, some idiot on the team will do it...
Bad command or file name. Bad, bad command! Sit! Stay! Staaaay...
-
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions)In my opinion you need to separate things. Code comments serve a different purpose than technical specs and to make it "worse", they have different life-cycles. They can change separately without a strict need to one affect the other. So in your code comments you can eventually refer to a section in the technical spec, but attaching pieces of documentation directly to code would be a maintenance mess.
-
Think of it this way: if you could post images in the Lounge, I probably would. But...so would spammers, viagra salesmen, trolls, and general morons. Which is why we don't have it! And do you really want your source code to expand that much? My backups are big enough as it is, without potentially adding an image per line of code (or even per method). You and I both know that if you can, some idiot on the team will do it...
Bad command or file name. Bad, bad command! Sit! Stay! Staaaay...
I'm pretty sure the risk is limited. It isn't a website and most teams are limited in size. You could build in a feature that seriously limits the file size per "attachment" and it will always remain more tedious to add an image than to write a comment.
V.
(MQOTD rules and previous solutions) -
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions) -
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions)Nice idea. Had felt this need sometime ago. One thing though. Would mean that source control should also include some kind of parental control - regarding image content. Or ratings like General, PG, etc. :-)
-
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions) -
:wtf: You write so many comments then? I doubt there will be many managers enforcing the developers to include every single line of documentation to the code. In short, this can never be the goal ?
V.
(MQOTD rules and previous solutions)V. wrote:
You write so many comments then
No. But we're discussing enough about what and how to commente, imagine Requirement & Use Case Engineering people being dragged into the very same discussion.
"A property doesn't have to be a Property to be a property." - PIEBALDConsult
-
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions)How about an IDE that loads all the crap *after* it has opened and not before? That way if I want to check a file I don't have to wait three days and slaughter a small chicken just to check how something was done. Bastard coders, too smart for there own godo!
veni bibi saltavi
-
I use case number or Wiki ID as a comment. VisualAssist SourceLinks[^] plugin turns these comments into links.
// Just double click bugz:12345 to see a nice picture of a aardvark
I'm going to have to ding you for poor commenting! The indeffinate article before a vowel is 'an' not 'a'!
veni bibi saltavi
-
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions)This still doesn't solve the problem of changing requirements, changing code, etc. 1. How do you ensure that comments remain current when requirements have been added / deleted? 2. ditto when code has been modified.
If you have an important point to make, don't try to be subtle or clever. Use a pile driver. Hit the point once. Then come back and hit it again. Then hit it a third time - a tremendous whack. --Winston Churchill
-
How about an IDE that loads all the crap *after* it has opened and not before? That way if I want to check a file I don't have to wait three days and slaughter a small chicken just to check how something was done. Bastard coders, too smart for there own godo!
veni bibi saltavi
-
How about an IDE that loads all the crap *after* it has opened and not before? That way if I want to check a file I don't have to wait three days and slaughter a small chicken just to check how something was done. Bastard coders, too smart for there own godo!
veni bibi saltavi
-
This still doesn't solve the problem of changing requirements, changing code, etc. 1. How do you ensure that comments remain current when requirements have been added / deleted? 2. ditto when code has been modified.
If you have an important point to make, don't try to be subtle or clever. Use a pile driver. Hit the point once. Then come back and hit it again. Then hit it a third time - a tremendous whack. --Winston Churchill
Go live in Utopia, there the specs are not changed afterwards :rolleyes:. I'm a bit surprised that everyone is worried about bloating or about the maintainence of this. I wouldn't have thought about putting these attachments everywhere I go, rather use it where normal comments don't really cut it. But I admit, I do live in my own private small world were none can enter ;-)
V.
(MQOTD rules and previous solutions) -
I'm going to have to ding you for poor commenting! The indeffinate article before a vowel is 'an' not 'a'!
veni bibi saltavi
-
This still doesn't solve the problem of changing requirements, changing code, etc. 1. How do you ensure that comments remain current when requirements have been added / deleted? 2. ditto when code has been modified.
If you have an important point to make, don't try to be subtle or clever. Use a pile driver. Hit the point once. Then come back and hit it again. Then hit it a third time - a tremendous whack. --Winston Churchill
85 million years ago, we had a simple submission check tool. The rules where that every file had a comment header with mod history and every public method had one too; this is all pre XML clever type doc/comments. If they were not there, or unchanged, the change could not be submitted. Simple yet effective.
veni bibi saltavi
-
I'm pretty sure the risk is limited. It isn't a website and most teams are limited in size. You could build in a feature that seriously limits the file size per "attachment" and it will always remain more tedious to add an image than to write a comment.
V.
(MQOTD rules and previous solutions)Or just make a link that, when clicked, opens the file. Shouldn't be all that hard to do. I don't know anything about Visual Studio AddIns/Extensions/etc, though.
What do you get when you cross a joke with a rhetorical question? The metaphorical solid rear-end expulsions have impacted the metaphorical motorized bladed rotating air movement mechanism. Do questions with multiple question marks annoy you???
-
Am I the only one who wants a feature in visual studio (or any other IDE) that can have images as comments? The idea would be that you have some sort of button in the side bar (when an image was attached at that location) and if you hover over it you see the image you attached. This image could contain a use-case, a drawing or a print out of a file you read in as example, ... If we think further you could attach paragraphs of the functional/technical documentation that are relevant for this piece of code. (but that might be overdoing it too) Just thinking out loud, but I feel the plain text comment is not sufficient ;-) What do you think?
V.
(MQOTD rules and previous solutions)
