определить помощь для переменной в Matlab

Question

В Matlab легко сгенерировать «помощь» для функции следующим образом.

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

Когда мы выполняем help foo, мы получаем «полезную информацию о foo».

Однако предположим, что мы хотели бы определить справку для переменной, вероятно, в качестве определения.Как мы могли сделать такую ​​вещь?Было бы хорошо, если бы мы могли сделать что-то вроде

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

и получить "m ... position".Однако я не верю, что такая функциональность существует.

Единственный разумный способ, который я вижу в этом, - определить каждую переменную как struct с ключами value и description.

* 1016.*

Это требует, чтобы мы определили каждую переменную как struct, что немного раздражает и, я волнуюсь (не так ли?), Не отвечает требованиям (это код моделирования и к этим переменным обращаются неоднократно).

Есть ли другое решение, которое я не рассматриваю?Должен ли я беспокоиться о том, чтобы сделать каждую переменную struct?

Answer 1

Ваш код должен быть самодокументированным.Вместо имени переменной x используйте position.

Кроме того, все переменные должны быть локальными, чтобы вы могли легко найти их определение (с комментарием) в редактируемой вами функции.

Переменные, объявленные дальше (с большей областью действия внутри функции), должны иметь более длинные, более понятные имена, чем переменные с меньшей областью действия (например, использование в коротком цикле.

) Существует только два случая, когдапеременные объявляются вне области действия функции:

1. Свойства класса. Фактически вы можете задокументировать эти .

2. в сценарии, у вас есть доступ к переменным, которые уже существовали до запуска сценария. Хорошая причина не использовать сценарии или зависеть от базового пространства имен в более крупных проектах.

3. Глобальные переменные. Никогда не используйтеглобальные переменные по многим причинам. Просто не надо.