Comments aren’t meant to be documentation

Documentation is supposed to be in the documentation, not in the code.

Some tooling generates documentation from comments. Like rustdoc or LDoc.

I’ll be honest, I mostly skimmed through your comment. Sorry if it’s something you touch upon later on.