Comment On Document Dis & Naked in the CIA?

Dey told me to post dis comment.

I did

Dey told me dis would be the first post.

It was not.

I had no idea lol cats wrote code.

Lars Vargas:

I had no idea lol cats wrote code.

HAI
CAN HAS STDIO?
VISIBLE "DEY DO"
KTHXBYE

Im in ur source files commenting ur codez

The CIA 'naked' reference may have something to do with __declspec(naked). This declaration, in Microsoft C++ at least, tells the compiler not to generate prologue and epilogue code - things like copying parameters passed in registers to the stack, setting up frame pointers, and the like.

Functions marked 'naked' are useful for interrupt handlers and other situations where you need direct access to the registers, and ensure that the compiler hasn't trashed the value in a register before you get to it, or before returning to your caller.

Lars Vargas:

I had no idea lol cats wrote code.

Well, they do.



Uh, well, it isn't a lolcat exactly.

ONLY_USE_NAKED_IN_CIA would generate a much better media frenzy than good old _NSAKEY. Just imagine all the innuendo-laden headlines.

Failing that, it could be a title of new TV spy series. I'm thinking Ally McBeal, only spooks instead of lawyers.

And apparently I cannot use correct tags.

I was pursing the Symbian documentation

So... were you stuffing the documentation into your purse, or were you wrinkling it up? Or perhaps doing both at the same time...

Damn deez doilies!

bd:

ONLY_USE_NAKED_IN_CIA would generate a much better media frenzy than good old _NSAKEY.

I CAN HAZ INGLISH PLEEZ? KTHXBYE

CAPTCHA: ingenium

Dey told me to send dem de codez.

I did.

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

Adriano:

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

FTA: "one of our subcontractors"

Adriano:

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

Nobody said it did. The submitter just pointed out that those three lines of sheer brillance were the only comments in the file. That's amusing by itself...

Maybe that was in the Sybian documentation.

shadowman:

Adriano:

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

Nobody said it did. The submitter just pointed out that those three lines of sheer brillance were the only comments in the file. That's amusing by itself...

Hence my "I won't try to justify the boneheaded comment" comment.

Mike Dimmick:

The CIA 'naked' reference may have something to do with __declspec(naked). This declaration, in Microsoft C++ at least, tells the compiler not to generate prologue and epilogue code - things like copying parameters passed in registers to the stack, setting up frame pointers, and the like.

Functions marked 'naked' are useful for interrupt handlers and other situations where you need direct access to the registers, and ensure that the compiler hasn't trashed the value in a register before you get to it, or before returning to your caller.

Mike has the right reason :)
NAKED is macro for __declspec(naked), or equivalent for other compilers
CIA refers to C++ files with Inline Assembler, nothing to do with spies, sorry ;)

I wouldn't be surprised if the pun was intentional though

The words 'dis' and 'dey' make me want to stab someone in the eye with a fork.

It's pretty obvious that Dey Woo asked the contractor to document the Distributed Information System. When he hadn't completed it by his 3 pm deadline, he started to make a note that he did not have time, except he was bludgeoned from behind by Mr. Woo for his incompetence.

SpoonMeiser:

The words 'dis' and 'dey' make me want to stab someone in the eye with a fork.

Apply on yourself, as it would serve 2 purposes at once:

1 - lose a grammar Nazi (WTF? Stab someone with a fork? Take your medicin)
2 - stop you being able to suffer further aggro from such mizspelinks

Just be careful where you put that fork afterwards. You may step on it.

SpoonMeiser:

The words 'dis' and 'dey' make me want to stab someone in the eye with a fork.

Better use a spork. It stabs autonomo^Wautonomus^Wall by itself!

Maybe the commentor couldn't find the "th" key.

SpoonMeiser:

The words 'dis' and 'dey' make me want to stab someone in the eye with a fork.

maybe you wanna fok? http://www.youtube.com/watch?v=m1TnzCiUSI0

Waffle:

Dey told me to send dem deh codez.

I did.

Fixed that for you.

Sue D. Nymme:

Maybe that was in the Sybian documentation.

I believe he meant simian documentation. Code monkeys and all that, you know.

SpoonMeiser:

The words 'dis' and 'dey' make me want to stab someone in the eye with a fork.

FredSaw:

Waffle:

Dey told me to send dem deh codez.

I did.

Fixed that for you.

Fixed dat for you.

Lars Vargas:

I had no idea lol cats wrote code.

dey sure do.

I saw a great comment in one of the earlier projects that I worked on:
/*
If anyone can work out what this code does then please call (developers home number)
*/

The code that this referred to had been removed but the comment was kept.

jMo:

Lars Vargas:

I had no idea lol cats wrote code.

dey sure do.

Good effort, but you're about two hours late.

How do you intend on using a Symbian without being naked?

Someone You Know:

jMo:

Lars Vargas:

I had no idea lol cats wrote code.

dey sure do.

Good effort, but you're about two hours late.

i would have sworn that the lolcode response was not linked when i posted.

i guess i get a demerit for tardiness and excessive linking then?

bad me.

SpoonMeiser:

The words 'dis' and 'dey' make me want to stab someone in the eye with a fork.

hundsfuts hautkopft von ulm:

And apparently I cannot use correct tags.

Are you sure it wasn't more like the following?

Ok, someone's going to have to explain why Germans seem to love making glasses out of forks.

hundsfuts hautkopft von ulm:

And apparently I cannot use correct tags.

That's a cat?

immibis:

That's a cat?

That's a cat who got a little too curious about the vacuum cleaner.

Vechni:

Adriano:

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

FTA: "one of our subcontractors"

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

lowkey:

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

A real programmer also understands that commented blocks of code can help you find sections quickly when maintaining and modifying a large body of code. Of course, you still have to make sure the comments aren't lying, but they can help you scan through sections quickly to find what you're looking for without having to dissect 100,000 other lines.

You should see the code at our work. Really well documented (Perl code, too, might I add?)... Except that half of it ends up doing the opposite off the comments.

//This code doesn't kill anything
kill such-and-such-process.

lowkey:

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

Any programmer can see what the code is doing (unless it's a certified tentacle of Codethulhu) but figuring out why can be a challenge. “I can see that it's twiddling some bits around in a complex way, but is it doing it to rearrange a memory mapped register, or to merge pixels in an image, or what? The name ‘twiddle_bits’ does not help…” One comment saying what the original author was trying to achieve would have helped a lot. (Comments are also good places for writing up preconditions, postconditions, and performance characteristics, but less-experienced programmers seem to sneer at making other peoples' lives easier, usually because they've not had to maintain their own code for five years yet.)

Not Germans, Austrian; Gottfried Helnwein to be precise. Probably because spoons tend to fall off, and forks offer more visibility for the wearer.

lowkey:

Vechni:

Adriano:

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

FTA: "one of our subcontractors"

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

You surely have not seen the code we have around here...

lowkey:

Vechni:

Adriano:

I won't try to justify the boneheaded comment, but "to document" doesn't necessarily mean "to add comments". He could have put the documentation in writing outside the source.

FTA: "one of our subcontractors"

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

You surely have not seen the code we have around here...

lowkey:

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

A real programmer would know enough not to post such an asinine thing on a forum frequented by actual real programmers. You're obviously not a programmer... Let's see - I can guess your real occupation, I'll bet.

You flip burgers... Nope. Not smart enough for that. You empty trash and clean toilets at the local McDonald's, right?

Comments are necessary sometimes to explain code that's complicated, or to explain to the next person who looks at it why you did something the way you did, or what bug that block of code addresses.

Now leave the real programmers alone to talk like grownups and get your ass back to work. I understand the toilet in stall two of the men's room is backed up again.

lowkey:

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

Others have commented on this but not quite the same as I would: The code only tells you what the code does, not what the code is supposed to do. This is why code is not, nor should be, requirements. Comments should reference a requirements document, change request or bug tracking database, etc. as well as briefly describe what the code is supposed to do. Then you can read the code and see if it does indeed appear to implement the requirement - then you test the code against the requirements.

Testing the code "x = 5+y" to see that x does indeed equal the sum of 5+y is useless unless you know that you really do want x to contain the sum of 5 and y.

i know this is getting commented on to death, but this crap about real coders viewing code and just knowing like some holy revelation is pure bull.

i am going to put this as nicely and neutrally as i can to anyone who thinks that code documents itself:

hey script-kid:
try reading a large block of assembly and just guessing what it does. when that is completed, please tread the water of your tears when you realize mom lied. you are not smart or creative.

lowkey:

A real programmer would read the code and understand what it did without needing a damn book included in the code - if you can't read the code and understand what it does, you shouldn't be screwing around with it. All code is self-documenting to those who know what they are doing...

Wow! That one sure caused a lot of whoosh above people's heads.
Chapeau.