在另见文档部分解决名称与内置函数的冲突答案

【问题标题】：Resolving name clashes with builtins in a see also documentation section在另见文档部分解决名称与内置函数的冲突
【发布时间】：2017-08-04 20:56:24
【问题描述】：

我有以下类，它有一个隐藏（或阴影）内置函数的方法。我希望文档包含一个“另见”部分，该部分链接到隐藏的内置函数。

classdef CatHelper
  %CATHELPER Makes implementing vertcat/horzcat easy on a custom class
  %
  %   See Also: cat

  methods (Abstract)
    obj = cat(obj, ndim, varargin);
  end
end

不幸的是，“另请参阅”链接只是试图为未记录的抽象方法 CatHelper/cat 提供帮助。

如何指定我希望链接转到 builtin cat 函数？

【问题讨论】：

我认为必须全部大写See also: CAT。
@mpaskov：不，它做同样的事情。两者都产生一个链接，但在这两种情况下，链接都指向matlab:help CatHelper/cat
如果你尝试链接到一个完全不同的函数，例如min/max，只是为了确保没有名称冲突。
@mpaskov：那就可以了。我的问题是专门关于解决名称冲突的。我已经更新了我的问题标题以明确说明
感谢您的澄清，看来您自己可能已经找到了答案。

标签： matlab class documentation shadowing token-name-resolution

【解决方案1】：

在与doc.m\resolveTopic() 玩了一会儿之后，我想出了如下所示的三个选项。前一个 (\cat) 给出了最好的结果，但你应该使用你认为对你的情况最不模糊的那个。

%   See Also: \cat
%   See Also: elmat\cat
%   See Also: matlab\elmat\cat

这些是通过将topic = 'cat' 传递到：

matlab.internal.language.introspective.resolveName(topic, '', false);

【讨论】：

【解决方案2】：

一个稍微难看的解决方法是只包含一个直接链接：

%   See Also: <a href="matlab:help cat">cat</a>

【讨论】：