How to properly document a line of code

Show your thinking and cite your best practices.

Demonstrating best practices that you invite other people to follow requires that you properly recognize the existing best practices. And if they are conflicting then you need to say why you picked one over the other.

When you do this you set a bar for other people to join the discussion--they will need to show examples rather than asserting the color for your bike shed.

The correct link is just this comment

https://github.com/fulldecent/moodle-local_plugin_template/i...

I'm not sure why HN chopped it off