Microblog Memes @lemmy.world 🃏Joker @sh.itjust.works 1 mo. ago

Code comments

// What is here was a dependency for us.
// This is a warning of a breaking change.// The change is in a particular package
// it is forked
// the fork is here
// and deep in the dependencies.// The fork is still present, in your time, as it was in ours. // The danger is to the velocity, and it is tech debt.// The form of the tech debt is an emanation of shell scripts.// The tech debt is paid only if you substantially
// depend on this workaround.
// This code is best removed and left unused.

You're viewing a single thread.

19 comments

My professor once asked me about a comment that said "// This is awful and you should feel awful, change this before handing it in. " I had no excuse, I just told him time makes fools of us all.
- I had no excuse, I just told him time makes fools of us all.
  
  For that quip, they should've just christened you a developer and handed over your diploma right there.
  
  Possibly with some yogurt
- Should always slap a TODO on the front. IDEs like Jetbrain will catch those for you, so you can willfully ignore them next time(s).
  
  willfully ignore them next time(s).
  
  That's a mood.
  
  Ideally with a ticket number, so you have some place with all the details and it can be prioritized and scheduled later, or never
  
  //TODO go through my comments and add the TODO flag
  
  //TODO ABC-1234 properly record tech debt
- This is the difference between academia and actual experience. Senior engineer wouldn't bat an eye for such comment
  
  That's basically what I was told. It worked, I explained the algorithm I was having trouble with, and that I just ran out of time. He didn't deduct any marks or anything, he just said I should make an effort to make comments less self-deprecating.
  
  I should make an effort to make comments less self-deprecating.
  
  Weird, that's what my therapist keeps telling me too. j/k, I can't afford it or be bothered to go

You've viewed 19 comments.