matlab - 在 Matlab 中定义变量的帮助

Question

在 Matlab 中，很容易为函数生成“帮助”，如下所示。

function out = foo()
  % helpful information about foo
end

当我们执行时help foo，我们会得到“关于 foo 的有用信息”。

然而，假设我们想为一个变量定义帮助，可能是一个定义。我们怎么能做这样的事？如果我们能做类似的事情就好了

x = 3; % m ... position
help x

并获得“m ...位置”。但是，我不相信这样的功能存在。

我看到的唯一合理的方法是将每个变量定义为struct带有键value和description.

x.value = 3;
x.description = 'm/s ... position';

这要求我们将每个变量都定义为struct，这有点烦人，而且我担心（我应该吗？），性能不佳（它是模拟代码，并且这些变量被重复访问）。

还有其他我不考虑的解决方案吗？我应该担心让每个变量都变成 astruct吗？

标签： matlabdocument

Answer 1

您的代码应该是自记录的。而不是变量名x，使用position.

此外，所有变量都应该是本地变量，因此您可以在正在编辑的函数中轻松查找其定义（带注释）。

声明得更远的变量（在函数内具有更大的范围）应该比具有更小范围的变量（例如在短循环中使用）具有更长、更不言自明的名称。

在函数范围之外声明变量只有两种三种情况：

1. 类属性。您实际上可以记录这些.

2. 在脚本中，您可以访问在脚本启动之前已经存在的变量。在大型项目中不使用脚本或不依赖基本命名空间的一个很好的理由。

3. 全局变量。出于多种原因，您永远不应该使用全局变量。只是不要。