MATLAB 不显示用户创建的类私有(private)方法和属性的帮助

Question

问题是:

1. 创建一个类并将某些属性或方法的访问权限设置为私有(private)。

2. 对创建的类使用doc 命令。这将根据您的评论自动生成文档，并在内置的帮助浏览器中显示。

   文档类名

问题是私有(private)属性和方法的文档没有显示在帮助浏览器中。有什么办法可以克服这个问题吗？

Answer 1

所以我花了大约 10 分钟使用调试器，从一个函数跳到下一个函数，跟踪一个简单的 doc MyClass 调用的执行路径。

最终它引导我找到以下文件:

fullfile(toolboxdir('matlab'),'helptools','+helpUtils','isAccessible.m')

此函数在为类生成文档的过程中调用，以确定类元素(包括方法、属性和事件)是否可公开访问和非隐藏。此信息稍后用于“剔除”元素。

因此，如果您愿意修改 MATLAB 的内部函数，并且希望文档始终显示所有方法和属性，而不管它们的范围如何，只需重写函数即可:

function b = isAccessible(classElement, elementKeyword)
    b = true;
    return

    % ... some more code we'll never reach!
end

当然，不要忘记备份文件，以防您以后改变主意:)

(在最近的 Windows 上，您需要使用管理权限执行此步骤)

---

作为测试，采用 this page 中定义的示例类并运行 doc someClass。结果: