|
I miss something. In about every project I ever had the pleasure to open, The Master of the Obvious would have left something like this behind:
public int DoSometihngObscurish(string ObscureParam, decimal[] ObscureArgs, Random theObfuscator); Spelling intentional. The Master of the Obvious designs everything he writes in a way that the reader gains no information beyond the obvious and, if possible, has even more questions than before.
In this documentation the Master of the Obvious forgot one essential thing;
Quote: Summary: This event notifies some other class that a property has changed.
I have lived with several Zen masters - all of them were cats.
His last invention was an evil Lasagna. It didn't kill anyone, and it actually tasted pretty good.
|
|
|
|
|
This is what happened when warning 1234 informs you, you must put a comment on that method. But your heart is not into it.
Code comments are nice, but I think they should NOT be mandatory for this exact reason.
|
|
|
|
|
Code comments and code documentation are two very different things, imho
667: The neighbour of the Beast
|
|
|
|
|
Click through to the INotifyPropertyChanged documentation, there is actually a nice example included.
|
|
|
|
|
99% of .NET framework documentation is made that way - that's why I hate .NET with a burning passion. Win32 API are much better documented, and still they don't approach the quality of Win16 documentation.
GCS d-- s-/++ a- C++++ U+++ P- L+@ E-- W++ N+ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t+ 5? X R+++ tv-- b+(+++) DI+++ D++ G e++ h--- ++>+++ y+++* Weapons extension: ma- k++ F+2 X
|
|
|
|
|
|
This is one of those pages that proves MS's documentation is generated by an automated tool, in case anyone still needs any convincing. Pulled entirely from source code--no comments, no documentation. Which infers developers are in charge of the documentation.
|
|
|
|
|
Or why clicking on a button does nothing?
I just did the former, and have done the latter. Doh. I need to run the program!
Latest Article - A Concise Overview of Threads
Learning to code with python is like learning to swim with those little arm floaties. It gives you undeserved confidence and will eventually drown you. - DangerBunny
Artificial intelligence is the only remedy for natural stupidity. - CDP1802
|
|
|
|
|
This usually happens to me when I have not had enough sleep.
|
|
|
|
|
Marc Clifton wrote: Or why clicking on a button does nothing?
I just did the former, and have done the latter. Doh. I need to run the program!
Perhaps a tad too concise, you forgot the .Start()
|
|
|
|
|
I was in a meeting with a coworker, my direct supervisor, and their direct supervisor (the head honcho, which I will call the PHB.)
As folks are gathering in the office, having not talked to the PBH for a few days, I ask "How was your weekend?" Response: "Fine, let's get started."
The PBH has a list of concerns/questions on his monitor. His office is so configured that if you sit directly across his desk, you can't see him because the monitors are in the way. If you sit at the table, you're talking to his back as he looks at his screen.
So, the PBH proceeds to ask the questions he's come up with on the monitor. Doesn't turn around to ask them, he basically asks them to his monitor. We respond, and he types in our responses.
Near the end of the meeting, he loudly grouses about how long the project has taken, and another project, dependent on my project, is starting to slip. I say something about the complexity of the project and the unexpected things we discovered (like how bad our data is, that needed to be cleaned up, bugs in things I'm dependent on, like reversing street and mailing addresses, and missing values from that code when it deserializes the XML into data structures, etc.)
The PBH response is basically, this project has taken ages, we need to finish it so that it is, and I quote "done, Done, DONE!"
What was missing from this conversation was:
1) What lessons have we learned so we don't make the same mistakes again?
2) What could management have done better?
3) Even though it's late in the game, would an additional developer or two help? (I'm the only developer on this massive project.)
4) Gee Marc, I really appreciate your hard work and diligence in making sure everything is done right.
Now granted, regarding #3, I could have raised that flag myself earlier in the game, but to my (poor) defense, and to my second failure, I really didn't understand the scope of the project. And by "scope", I mean the lack of documentation of how the company's data "works" depending on the line of business, how buggy the data was, etc.
So, here's a toast to Dilbert, the hero of all of our nightmare projects and PHB's!
Latest Article - A Concise Overview of Threads
Learning to code with python is like learning to swim with those little arm floaties. It gives you undeserved confidence and will eventually drown you. - DangerBunny
Artificial intelligence is the only remedy for natural stupidity. - CDP1802
modified 20-Sep-18 19:45pm.
|
|
|
|
|
Marc Clifton wrote: I really appreciate your hard work and diligence in making sure everything is done right.
Funny you mention this. I was thinkg the same thing for myself here at work.
I still haven't heard an elephant fart of a thank you anywhere, from anyone.
|
|
|
|
|
Thank you? You're not doing the work as a favor out of the goodness of your heart. You're doing the work because you're getting a paycheck.
The difficult we do right away...
...the impossible takes slightly longer.
|
|
|
|
|
Richard Andrew x64 wrote: You're not doing the work as a favor out of the goodness of your heart. You're doing the work because you're getting a paycheck.
Absolutely true. However, a little bit of appropriate praise once in a while can go a long way toward keeping employees happy. It isn't the number one reason employees leave, but it is the number eight[^]. Its a soft skills managementy thing.
|
|
|
|
|
Richard Andrew x64 wrote: You're doing the work because you're getting a paycheck.
Paychecks are the material result. As human beings, it's also nice to receive some positive feedback for our emotional well-being and ego.
Latest Article - A Concise Overview of Threads
Learning to code with python is like learning to swim with those little arm floaties. It gives you undeserved confidence and will eventually drown you. - DangerBunny
Artificial intelligence is the only remedy for natural stupidity. - CDP1802
|
|
|
|
|
Slacker007 wrote: I still haven't heard an elephant fart of a thank you anywhere, from anyone.
Well, allow me to be the first to profusely thank you for all your hard work!!!
Latest Article - A Concise Overview of Threads
Learning to code with python is like learning to swim with those little arm floaties. It gives you undeserved confidence and will eventually drown you. - DangerBunny
Artificial intelligence is the only remedy for natural stupidity. - CDP1802
|
|
|
|
|
Same to you.
and to show how thankful we are of your hard work Marc, I am giving you a 10% raise in pay, effective immediately!
|
|
|
|
|
|
I'm sure they did, and it appears that it would be beneficial to give some to Congress, as well.
Will Rogers never met me.
|
|
|
|
|
Roger Wright wrote: I'm sure they did, and it appears that it would be beneficial to give some to Congress, as well.
Not sure how it works over there, buit I want our politicians on downers and or sleeping tablets so they can't get anything done to further faarrrkkkk things up.
Been flat out and haven't had a chance to respond yet. Friday today so should reply tonight.
Michael Martin
Australia
"I controlled my laughter and simple said "No,I am very busy,so I can't write any code for you". The moment they heard this all the smiling face turned into a sad looking face and one of them farted. So I had to leave the place as soon as possible."
- Mr.Prakash One Fine Saturday. 24/04/2004
|
|
|
|
|
Michael Martin wrote: Not sure how it works over there, buit I want our politicians on downers and or sleeping tablets so they can't get anything done to further faarrrkkkk things up
You figjam up yourself cockroaches and your opinions.
We've the best of the pollies down here according to a pamphlet from Canberra that I read in me boozer. Don't you know it's gotta be the bloody oath if it's from Canberra! It also went on about how all the rorts are actually across the pond.
|
|
|
|
|
Rajesh R Subramanian wrote: We've the best of the pollies down here according to a pamphlet from Canberra that I read in me boozer. Don't you know it's gotta be the bloody oath if it's from Canberra! It also went on about how all the rorts are actually across the pond.
We all know that Australia's problem's are created outside of our border's. If it ain't the Yanks or the Poms it's gotta be those bloody Kiwis.
As for <insert current="" pm="" name="" here="">, s/he's great, while s/he's in charge for the next few weeks all our problems will be solved.
Michael Martin
Australia
"I controlled my laughter and simple said "No,I am very busy,so I can't write any code for you". The moment they heard this all the smiling face turned into a sad looking face and one of them farted. So I had to leave the place as soon as possible."
- Mr.Prakash One Fine Saturday. 24/04/2004
|
|
|
|
|
We used to have eight legs. Scientists will find out why we only have two left.
TOMZ_KV
|
|
|
|
|
@ChrisMaunder, did one of your unit tests fail and you didn't fix it???
[edit] Hmmm...it's under the Features dropdown now. [/edit]
[edit2] Nope, that's to sign up for the newsletter. Saw "Insider" and thought that was it! [/edit2]
[edit3] It's baaaaack! [/edit]
Latest Article - A Concise Overview of Threads
Learning to code with python is like learning to swim with those little arm floaties. It gives you undeserved confidence and will eventually drown you. - DangerBunny
Artificial intelligence is the only remedy for natural stupidity. - CDP1802
modified 20-Sep-18 17:59pm.
|
|
|
|
|