When an issue pertains to some code, and someone knows a solution, they sometimes just dump code into a reply without explaining it.
This is an issue because the person who made the question won’t be able to learn from it easily, and future readers who come across this won’t be able to either.
So I suggest encouraging explaining code.
Thanks for this reminder/suggestion. I have to admit that I am guilty of this habit of dumping code without further explaining what it actually does, however when I have the time, I go back some of these replies of mine and give a proper explanation.
Perhaps the author of the thread could also request for an explanation if they really need one or if they need further explaining.
Yes, I agree. After all, just giving the code without an explanation is like giving a person a play script written in an unknown language and telling them to memorize it. That doesn’t teach them the language, it only “teaches” them that specific wording.
Therefore, I also encourage helpers to add explanations to help new developers understand rather than memorize. Great suggestion!
But the fact that they had to.
Explaining scripts should be a habit for everyone. Something done by “default”. And it’s logical imo. How do you expect them to understand when you just dump in a script. Especially when not everyone has all that knowledge they might still be learning.
Well, of course it’s everyone’s right here on the forum to get an explanation or have a chance to learn. Not everyone will just add an explanation all the time, unless it actually becomes mandatory and can be a “flaggable” offense when failing to comply.
Post authors should also follow up for an explanation if none was given or if the existing explanation was not enough to understand on their part, this will allow others to give their understanding on the provided code, and not just one’s perspective. However it’s not supposed to be the author’s responsibility to ask for one. This is the point of your request.
I agree that everyone who helps with code should make it a habit to include an explanation, however keep in mind that not all people on the forum are professionals. Not everyone would know exactly what to say about their code. Some people just simply knows how to write code, but not know how to put it into words.
I believe this is why it was not made mandatory to put explanations because these kinds of people exist in this forum. If everyone was forced to explain their code, it may lead to wrong information being passed around. I think there is much more that needs to be cleared up before explaining code by default becomes mandatory.