docs: documentation comments

[lars-reimann]

Closes partially #669

Summary of Changes

Document how to write documentation comments.

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ MARKDOWN	markdown-link-check	1		0	0.43s
✅ REPOSITORY	git_diff	yes		no	0.1s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

[codecov]

Codecov Report

Merging #765 (302b468) into main (e049148) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #765   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           80        80           
  Lines        11594     11594           
  Branches      2417      2417           
=========================================
  Hits         11594     11594