everydaykrot.blogg.se - Matlab 2012 documentation

%#MYMETHOD calls up the help for the objectĮdit 1 If you want a nice html documentation, you can, in addition, use m2html to generate it for you. %%# MYMETHOD - use %% so that you can easily navigate your class file %# myMethod - sample method that calls doc %# myProp - empty sample property (some more explanation could follow here) It implements the following properties and methods:

%# m圜lass is an example for documentation. %# All this text will show up at the top of the help if you call 'doc m圜lassName'

In addition, all my classes subclass a general superclass which implements (among others) the method 'help' that calls doc(class(obj)), which allows me to bring up the help from every instance of the class. When you call 'doc m圜lass', you will see (1) at the beginning, followed by the list of properties explained by the sentences you added in (2) and the list of methods that show the H1-line and the rest of the help (3) if you click on the link. it has a H1-line, a synopsis, and an explanation of the input and output parameters. Each method is documented like a function, i.e.

After each property definition, I add one explanatory sentence about it (on the same line).

I also explain properties in detail and I add a 1-sentence description of each method.

At the beginning of the file that contains 'classdef', I write a summary of what the class does, and typical usage.