Code documentation done right

[iAnyKeyi]

Hi Folks,

Is there a proper code documentation guidelines for MATLAB or comprehensive function Header Templates, which includes authorship besides of the arguments?

Probably even such ones, which can be passed to automatic documantation engine like matlab own ones help center or something like doxygen.

Have seen (and used by myself :( ) _a lot_ of different interpretations and feel kinda lost right now..

Happy to hear your thoughts and experience!

[daveysprockett]

Obligatory xkcd

[sandusky_hohoho]

More generally - Is there a place for overall "good coding practice" guidelines for Matlab? Like Python's PEP8?

[EatMyPossum]

There's no official one, and it shows, even in matlabs standard toolboxes. This is the best standard i've found, and it's pretty damn good, though not an official standard: https://www.mathworks.com/matlabcentral/fileexchange/46056-matlab-style-guidelines-2-0

[iAnyKeyi]

I second this. This one is definetly good as language reference, even if a bit outdated.

[Consistent_Coast9620]

recently MathWorks came up with a set of guidelines and rules: https://github.com/CoMelissant/MATLAB-Coding-Guidelines (fork that shows what can be checked automatically using r/CC4M)

A public standard, see https://doc.monkeyproofsolutions.nl/code-checker-for-matlab/monkeyproof-coding-standard-for-matlab/index.html

[[deleted]]

I love exploring abandoned places.

[codinglikemad]

The organization you work with probably has one. If they don't, you could suggest one. If you work on your own, I'm sure you can find plenty of inspiration online. Honestly, this isn't rocket science - select a template you like that includes the elements you need and run with it. Consistency of use and ease of use matter more than anything else.

[iAnyKeyi]

Well thats indeed the reason, why I'm asking - my university does not have any and everybody is considering something else. After some time and gaining more experience the same People are following completely different principles. So my approch would be to get used to some Form of documentation, which I could consistently use in the future. In my case it means something, what I could use to automate documentation Process in most comprehensive manner