Prev: SImulink help plz
Next: Redirecting standard output ?
From: Fabrice on 3 May 2010 03:30
"Joel " <joel.j.k.parker(a)nasa.gov> wrote in message <hn89dh$aa9$1(a)fred.mathworks.com>...
> I'm writing a sizeable application using object-oriented MATLAB, and this has gotten me thinking about how to document the code. If this was C, I would use Doxygen. For Java, I'd use JavaDoc. Both have mostly agreed-upon standards for how class and method documentation should look and what it should contain.
>
> But what about MATLAB code? The most I've seen in TMW's own classes is a short sentence or two at the top of the class, and I can't find any topics devoted to documenting sizeable MATLAB applications.
>
> So how do you document your MATLAB classes? Any particular style issues or additional tools?

Hi,

You should have a look at the Doxygen package I have posted on the Matlab File Exchange (http://www.mathworks.com/matlabcentral/fileexchange/25925).

This package converts Matlab .m files into C++ files that Doxygen can understand : the object-oriented code (classdef, methods, properties,...) is supported by this package.

Doxygen can then extract the comments from your code.

Regards,

Fabrice
 | 
Pages: 1
Prev: SImulink help plz
Next: Redirecting standard output ?