|
Adding two spaces after a period is something that so many people seem to do, despite others obviously going for what they believe to be the correct choice and using just one space. I guess they've already fixed all the bad stuff
|
|
|
|
|
They'll have to pry my from my cold, dead hands! 
|
|
|
|
|
Someone who is obviously an idiot said: While the two-space rule actually made sense in the era of typewriters
I'll agree that that makes sense to idiots, and to people with absolutely no spatial awareness whatsoever.
Let your faith lie in the truth, not stand in lies[^].
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
In this time of craziness it's refreshing there are small pockets of sanity.
Next they need to hunt down and kill the "--" I see in text. Use a single dash, or an em-dash if you have the ability, but tautologic punctuation must die.
cheers
Chris Maunder
|
|
|
|
|
Chris Maunder wrote: Next they need to hunt down and kill the "--" I see in text
If they include it in all MS software not only office...
Good luck with HTML comments in VS 
M.D.V. 
If something has a solution... Why do we have to worry about?. If it has no solution... For what reason do we have to worry about?
Help me to understand what I'm saying, and I'll explain it better to you
Rating helpful answers is nice, but saying thanks can be even nicer.
|
|
|
|
|
Nelek wrote: Good luck with HTML comments in VS
For HTML, remove the space in "&n dash;" and you get "–".
But typing "--" always means an en-dash, in all contexts, and makes it easier for you to see what you're writing.
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
And I meant if they do an auto-correct of the "--" to "-" then...
<!--
<tag>
whatevert
</tag>
getting changed to
<!- vs this with one ->
<tag>
whatevert
</tag>
might get funny.
M.D.V.
If something has a solution... Why do we have to worry about?. If it has no solution... For what reason do we have to worry about?
Help me to understand what I'm saying, and I'll explain it better to you
Rating helpful answers is nice, but saying thanks can be even nicer.
|
|
|
|
|
I'd buy that program just to complain about it when it doesn't run!
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
In copy and manuscripts for publication/printing, you insert two hyphens to indicate an en-dash, and three for an em-dash, and you don't use symbols that may not be present in the machines used by the fifteen people along the line who have to handle your text, so I'm afraid it's a sign that professional standards are being followed, not a mistake.
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
To Hell with professional standards! Chaos and misplaced apostrophe's for all!
cheers
Chris Maunder
|
|
|
|
|
Chris Maunder wrote: misplaced apostrophe's
That's "greengrocers apostrophe's"! 
Some standards must be upheld!
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
cheers
Chris Maunder
|
|
|
|
|
There is a right way and a wrong way to perform code commenting in source code; here's what not to do. // why not?
|
|
|
|
|
Yet another person who couldn't walk the walk, yet feels qualified to tell those of us that *can*, how it should be done....
".45 ACP - because shooting twice is just silly" - JSOP, 2010
-----
You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
-----
When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013
|
|
|
|
|
Them as can, do; them as can't become bad teachers.
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
0: Remember that adding "the dog's" means it's good
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
Quote: Don't comment on the obvious
This dogma, more than anything else, is the root of all evil when it comes to "how to comment" posts.
I couldn't even guess the number of times someone has assumed something is "obvious" but is clearly highly ambiguous, or worse, totally and utterly not obvious. I've even done it myself: made a pithy comment since I thought it was obvious and then, 6 months later, had no idea what was going on.
And then there's the "obvious" at the time and for the situation, but then times and situations change. New functionality, new technology, even the changing use of terminology means things become un-obvious very quickly.
Comment always. Comment to clarify. Comment to tell the story of what you feel the code should be doing even if it's obvious because that one comment, that one tidbit, could save a dev a week of pain or worse - a catastrophically bad assumption.
cheers
Chris Maunder
|
|
|
|
|
obvious (IMO) to avoid:
// declare variables
// implement code
#SupportHeForShe
Government can give you nothing but what it takes from somebody else. A government big enough to give you everything you want is big enough to take everything you've got, including your freedom.-Ezra Taft Benson
You must accept 1 of 2 basic premises: Either we are alone in the universe or we are not alone. Either way, the implications are staggering!-Wernher von Braun
|
|
|
|
|
Even that much does no harm, afaics.
|
|
|
|
|
It does no good either and is annoying as hell when there's no comments saying WHY something is being done.
Don't tell me WHAT you are doing, I can read that. Tell my WHY you are doing it.
#SupportHeForShe
Government can give you nothing but what it takes from somebody else. A government big enough to give you everything you want is big enough to take everything you've got, including your freedom.-Ezra Taft Benson
You must accept 1 of 2 basic premises: Either we are alone in the universe or we are not alone. Either way, the implications are staggering!-Wernher von Braun
|
|
|
|
|
TheGreatAndPowerfulOz wrote: It does no good either and is annoying as hell when there's no comments saying WHY something is being done.
Yes, but that's obvious, so you don't need to document it.
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
LMAO. 
#SupportHeForShe
Government can give you nothing but what it takes from somebody else. A government big enough to give you everything you want is big enough to take everything you've got, including your freedom.-Ezra Taft Benson
You must accept 1 of 2 basic premises: Either we are alone in the universe or we are not alone. Either way, the implications are staggering!-Wernher von Braun
|
|
|
|
|
In fairness, he did say but think carefully about what is obvious. He didn't clarify it very well, however, and your point is well taken.
I would add
6. Don't constantly interrupt the code with comments.
I loathe reading code with intrusive comments. This includes trailing comments, which are rarely appropriate outside of assembler. I'd rather read a paragraph that describes what a block of code does, after which the code is allowed to flow and speak for itself.
|
|
|
|
|
Still, I guess the thing is that code comments are not enforced by the compiler.
So you may end up with smth like this after some refactorings (actually a real code I've witnessed)
public void IncreaseCounter()
So I'd rather abstain from code comments unless I really need them. Lots of stuff can be fixed with the right naming and extract method or complex conditional refactoring.
|
|
|
|
|
Sorry but this is actually not related to "comment or no comment" it is more related to "lazy copy+paste and don't do it consequent"
But yes... I can give you that. Bad placed comments can be more dangerous that no commets at all.
M.D.V. 
If something has a solution... Why do we have to worry about?. If it has no solution... For what reason do we have to worry about?
Help me to understand what I'm saying, and I'll explain it better to you
Rating helpful answers is nice, but saying thanks can be even nicer.
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
