如何评论MATLAB变量

Question

当我使用MATLAB时，有时我觉得需要对一些变量进行注释。 我想将这些注释保存在这些变量中。 因此，当我不得不在工作空间中使用许多变量，而又忘记了其中一些变量的上下文时，我可以阅读我在每个变量中添加的注释。 因此，我想注释变量并将注释保留在变量内。

Answer 1

虽然我认为最好的（和最简单的）办法是给他们描述性的名称，让您的变量自我记录的，实际上是为你做你想要使用的是什么MATLAB的面向对象的方面的方式。 具体来说，您可以创建一个新类，该新类将内置类作为子类，以便它具有描述变量的附加属性。

实际上， 文档中有一个示例可以完全满足您的要求。 它创建一个行为类似于double的新类ExtendDouble ，不同之处在于它具有附加的DataString属性，该属性描述了变量中的数据。 使用此子类，您可以执行以下操作：

N = ExtendDouble(10,'The number of data points')
N = 
The number of data points
     10

N可以在表达式中使用，就像任何double值一样。 使用该示例子类作为模板，可以创建其他内置数字类的“注释”版本， 但不允许子类 （ char ， cell ， struct和function_handle ）除外。

当然，应该注意的是， ExtendDouble像上例中那样使用ExtendDouble类， ExtendDouble像这样定义变量：

nDataPoints = 10;

这使得变量可以自我记录，尽管需要更多键入。 ;）

Answer 2

为您的评论声明另一个变量如何？
例：

\>> num = 5;  
\>> numc = 'This is a number that contains 5';  
\>> whos  
...

这是我在StackOverflow中的第一篇文章。 谢谢。

Answer 3

解决此问题的一种简便方法是拥有一个为您存储和显示评论的函数，即类似于下面的函数，如果您使用comments('myVar')进行调用，它将弹出一个对话框。为标记为myVar变量（或函数或同事）输入新的（或读取/更新先前的）注释。

请注意，注释将在您的下一个Matlab会话中不可用。 为此，您必须在comments添加保存/加载功能（即，每次更改任何内容时，都会写入文件，并且每次启动该功能且database为空时，如果可能，都将加载文件）。

function comments(name)
%COMMENTS stores comments for a matlab session
% 
% comments(name) adds or updates a comment stored with the label "name"
%
% comments prints all the current comments

%# database is a n-by-2 cell array with {label, comment}
persistent database

%# check input and decide what to do
if nargin < 1 || isempty(name)
    printDatabase;
else
    updateDatabase;
end

    function printDatabase
        %# prints the database
        if isempty(database)
            fprintf('no comments stored yet\n')
        else
            for i=1:size(database,1)
                fprintf('%20s : %s\n',database{i,1},database{i,2});
            end
        end
    end
    function updateDatabase
        %# updates the database

        %# check whether there is already a comment 
        if size(database,1) > 0 && any(strcmp(name,database(:,1)))
            idx = strcmp(name,database(:,1));
            comment = database(idx,2);
        else
            idx = size(database,1)+1;
            comment = {''};
        end

        %# ask for new/updated comment
        comment = inputdlg(sprintf('please enter comment for %s',name),'add comment',...
            5,comment);

        if ~isempty(comment)
            database{idx,1} = name;
            database(idx,2) = comment;
        end
    end
end

Answer 4

始终始终保持Matlab编辑器处于打开状态，并带有记录您所做操作的脚本。 也就是说，变量分配和计算。

只有例外是您要尝试的非常短的会话。 拥有内容后-将其添加到文件中（查看完整的历史记录也更容易剪切和粘贴）。

这样，您可以始终重新开始。 只需clear all并重新运行脚本即可。 您的工作空间中永远不会有随机的临时对象。

最终，完成后，您还将获得一些接近“可交付成果”的东西。

Answer 5

您是否考虑过使用结构（或单元，尽管结构将需要额外的内存使用）？

'>> dataset1.numerical = 5;

'>> dataset1.comment ='这是包含5的数据集';

 dataset1 = 
   numerical: 5
   comment: 'This is the dataset that contains 5'