Documentation for protected/private methods

Question

Peter Borda 2020-10-6

1
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/606166-documentation-for-protected-private-methods

编辑： Peter Borda 2020-10-6

Hello!

I find the Matlab built-in solution for automatically generating classdef documentation page to be quite a handy solution:

doc MyClassdef

Following some basic commenting rules it makes rapid documentation lot easier.

However, I bumped into an issue, for which I couldn't find a work-around yet... I define some static methods using some external m-files. The external file contains all the explanations and help for the user, so that the main classdef can be kept relatively clean. These 'documentation-snippets' however cannot be accessed over the rapid Matlab documentation tool if they are set to private or protected, thus all the help is hidden...

classdef MyClassdef
    methods 
        function SomeUserTriggeredFunction(varargin)
            a = obj.ExternalStaticMethod(varargin);
        end
    end
        
    methods (Static, Access = ?Protected)
        a = ExternalStaticMethod(varargin)
    end
end

A fast-foreward solution would be to get rid of the external m-file and copy every single comment line directly in the 'SomeUserTriggeredFunction' methodm, but I would end up with a classdef containing tons of comments.

What would be your proposed solution for the situation? Do you have any idea for keeping the main classdef clean, but also giving the user the possibility to access the helps?

Many thanks in advance! BOPe