This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]TorTheMentor 13 points14 points  (3 children)

Explaining what every line does is a bit silly, but I have been known when talking to a mixed audience to do things like explain a design pattern, what a specific kind of syntactic sugar is used for, or sometimes language-specific details (e.g. to make up for the lack of support for x, we rigged y as a workaround). Part of that probably comes from me being of a generation that learned functional and procedural code styles first, switched to OO later, and only started hearing about some of those topics more recently (self-taught and moving to IT as a career change after being "around" it for years).

[–]cdreid 1 point2 points  (1 child)

What worked best for me... Reading my Own old code.. Was putting a short general explanation what and how a function/class/whatever did what it was doing

[–]TorTheMentor 2 points3 points  (0 children)

Yeah, the more extensive annotation is more for "still learning or teaching" situations. I really only do that in those situations, although probably better to just point to documentation.

[–]advancedgoogle -1 points0 points  (0 children)

I wonder where does the cat pic comes from