DEV Community

loading...
Cover image for What I hate hearing most as a developer.

What I hate hearing most as a developer.

Michael Lee πŸ•
Maker of things, giver of high-fives πŸ–
・1 min read

Alt Text

A. Using Vim makes you more productive ⌨️
B. This should be low-hanging fruit πŸ‡
C. Looks good on my screen πŸ‘¨β€πŸ’»

Or suggest your own answer.

Discussion (23)

Collapse
pbouillon profile image
Pierre Bouillon

I don't need to write documentation, just look at the code

Collapse
bootcode profile image
Robin Palotai

The trick is, write documentation with honesty, but read documentation with a healthy bit of reservation. Code lies less often.

Collapse
michael profile image
Michael Lee πŸ• Author

😀

Collapse
metalmikester profile image
Michel Renaud

That's why I'm careful about WHAT I document. I try to keep it general enough so that refactoring and such won't affect the documentation. Easier said than done, mind you!

Thread Thread
michael profile image
Michael Lee πŸ• Author

Michel, if you've got some tips on how you do this, it'd be great!

Thread Thread
metalmikester profile image
Michel Renaud • Edited

I'm not saying I'm working any miracles here, but I've rarely had people come back to me after taking over code I've written:

In separate documentation (e.g. Word document, whatever):

  • High-level explanation of the system, maybe down to the module level (depends on the application...)

  • Doing anything really weird? Explain the madness without getting too much into the implementation details. For a recent project, I was getting input from a query builder and generating and executing C# code on the fly (using Roslyn). There were some tricky parts and it's not obvious from just looking at the code, so I explained the flow of things.

In the code, I used to be big on comments, and I still write them, but less. That's after realizing they often went out of sync. So, variable and method names as descriptive as possible. No Hungarian notation garbage, no dropping the vowels in identifiers, etc. If something is weird or a workaround (sometimes to address a bug or shortcoming in a library or framework), then I'll document that. I just did that this morning for a workaround I had to do so something would display properly in a specific browser. That will save future generations from wasting time trying to do that tiny part the same way the rest is done.

I'm sure there's more, but as you can see it's nothing out of the ordinary. Just experience built over 31+ years of frustration doing this kind of work, for the most part. :D

Collapse
metalmikester profile image
Michel Renaud

A coworker just had four months of work tossed away because the other two developers on the team didn't want to upgrade their skills...

"Oh, it's too hard!" I don't know how many times we've been held 10-15 years back because of people like that. I also see that as a management failure to some extent.

(Note: No, it's not)

Collapse
michael profile image
Michael Lee πŸ• Author

Oh no! That must've been demoralizing for your coworker...

Collapse
metalmikester profile image
Michel Renaud

No kidding. I wasn't too pleased myself. I've seen too much of that throughout my career...

Collapse
metalmikester profile image
Michel Renaud

I remember a friend of mine working with Vim and barely being able to follow what he was doing. He was THAT fast with it. It's not for everyone. I've tried it a few times, but I'm too used to modern luxury nowadays. :D I do use it on occasion when using SSH on a server, stuff like that, but only for very basic editing.

I use to care. Now I'm more of the "use what works for you, I'll use what works for me" type. Note that that doesn't stop me from checking out something I haven't used previously if someone suggests it as an option.

Collapse
amc2010 profile image
Rob

Psssh,I don't need to test/debug.

Collapse
engineercoding profile image
Wesley Ameling

We will do it properly in the future

Collapse
djmoch profile image
Daniel Moch

Just make it work. (The implication being to get it done as fast as possible without regard to intangibles like maintainability or architectural correctness.)

Collapse
metalmikester profile image
Michel Renaud

I used to work for that guy. :D

Collapse
christopherlai profile image
Christopher Lai

D) A Slack DM that starts with: "Quick question". It's never a quick question...

Collapse
brieucp profile image
brieucp

Oh, you work on computer ... Can you fix mine ?

Collapse
michael profile image
Michael Lee πŸ• Author

Every family holiday...😩

Collapse
ogaston profile image
Omar Gaston Chalas

I think like, all of the above.

Collapse
peterwitham profile image
Peter Witham

The one that always gets me is

"Our priorities have changed"

That rarely means all the code you just wrote can still be used :)

Collapse
dathart profile image
dathart

looking at major changes in the code

Oh, it only takes a few minutes of your time.

Collapse
michael profile image
Michael Lee πŸ• Author

Neil, really appreciate your thoughtfulness around each prompt. I can definitely see opportunities of improvement.

Collapse
michael profile image
Michael Lee πŸ• Author

It was due yesterday, can you escalate it now?!