DEV Community

Discussion on: A case for code comments?

Collapse
 
kushaljoshi profile image
Kushal Joshi

Don't agree with the "don't use slang" part.

Sometimes slang is often more expressive and descriptive and only takes 10 secs to lookup unless it's some esoteric rarity.

Just speak your speak and we can all learn your things. Embrace the difference.

(Apart from that, Awesome post!)

Collapse
 
scottydocs profile image
James.Scott

You've kind of touched upon on it but my main argument for not using slang or dialect is most engineering teams are diverse and multicultural (I don't think I've ever worked in or heard of a team where every single developer was from the same continent let alone the same country!).

I'm not saying we shouldn't embrace difference in language in person or over Slack etc but it's just definitely worth bearing in mind that using slang in code comments may act as a blocker for your teammates and potentially slow their velocity.

Collapse
 
kushalj profile image
Kushal Joshi

True. And worth considering of course. I've seen "we shouldn't say this and that" get out of hand and go the wrong way too so, yes, a tempered approach to slang and colloquialisms is a nice balance that still embraces the fun things.