MATLAB类的描述和DetailedDescription属性 [英] Description and DetailedDescription attributes of MATLAB classes

问题描述

内置的MATLAB类具有描述"和详细描述"属性的值:

Built-in MATLAB classes have values for a Description and DetailedDescription attribute:

>> ?handle
ans = 
  meta.class handle
  Package: meta

  Properties:
                     Name: 'handle'
              Description: 'Base class for handle classes'
      DetailedDescription: ''
[snip]

类似地，内置类的某些方法和属性具有相同的属性:

Similarly, some methods and properties of built-in classes have the same attributes:

>> a = ?containers.Map;
>> a.PropertyList(1)
ans = 
  meta.property handle
  Package: meta

  Properties:
                   Name: 'Count'
            Description: 'Number of pairs in the collection'
    DetailedDescription: ''
[snip]

如何为我的类/方法/属性设置这些属性?

How can I set these attributes for my classes/methods/properties?

推荐答案

对classdef使用参数:

Use arguments to the classdef:

classdef (Description='A type of story.',...
    DetailedDescription='Once upon a time..') MyFairyTaleClass

命令行:

>> ?MyFairyTaleClass

ans = 

  meta.class handle
  Package: meta

  Properties:
                     Name: 'MyFairyTaleClass'
              Description: 'A type of story.'
      DetailedDescription: 'Once upon a time..'
                   Hidden: 0
                   Sealed: 0
          ConstructOnLoad: 0
         HandleCompatible: 0
          InferiorClasses: {0x1 cell}

这似乎是未记录的功能.

这篇关于MATLAB类的描述和DetailedDescription属性的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！