Как визуализировать структуру проекта в MATLAB?

Имеет ли ваш код подходящий текст справки? В этом случае m2html будет большой помощью, так как это позволяет вам создать связанную html-справку для удобного просмотра.

Кроме того, он позволяет создавать графики зависимостей, которые помогут вам понять немного больше, как вы можете организовать код.

Мне приходилось много раз заниматься этой проблемой в моих различных ролях в The MathWorks. Это то, что я делаю для больших фрагментов кода MATLAB:

• Сделайте резервную копию, может быть, дважды!
• Выбрать все, Ctrl-I для интеллектуального отступа

• Выделить все, Ctrl-J, чтобы обернуть комментарии

• Если я чувствую бумагу - распечатайте все файлы и получайте набор маркеров - следуйте вручную, выделив долгосрочные переменные и важные вызовы функций.

~~~ AND/OR ~~~

5 Если мне повезет, запустите код в отладчике, пройдя через по одной строке за раз (вступая в подфункции, которые были написаны пользователем)

В этот момент я могу пройти и следовать типичному потоку через структуру управления. У меня, возможно, нет отличной идеи, что все делает, но у меня есть приличное представление о том, что происходит.

Обычно моя цель - найти ошибку, решить ее и продолжить. Ваши цели могут быть совершенно разными. Это метод, который я использовал, чтобы быстро постигнуть хрустали разных частей кода MATLAB, которые я отправил с годами.

Руководство по стилю программирования MATLAB от Ричарда Джонсона - хороший ресурс.

некоторые предложения относительно соглашения о кодировании Matlab:

• использовать addpath для предотвращения загромождения файлов и оказания помощи в функциях taxnomony

• Разбить раздел_ для функциональных скриптов или установить для условных прогонов, это также может помочь в модулях plug-in/out и повторного использования или ссылки на код.

• используйте конфигурационный файл для включения и выключения параметров

• имеют общий обзор архитектурного набора конструкций, а также modus operandi
• сохранить файл status/readme (рассматривать себя как нового пользователя, как бы вы помогли сделать его ассимилируемым как часть собственного модуля или части решений для нового пользователя, если вы вернетесь к коду 3 спустя несколько месяцев чувствуя себя потерянным или неспособным проследить - что-то не так.) Мое предложение: держите журнал, чтобы уточнить свои мысли о сохранении искусных проектов. Продолжайте совершенствовать свое искусство!
• для уравнений, используйте латекс для документирования (и храните его в ближайшей папке под названием, например, документы, убедитесь, что они легко доступны и прослеживаются - если вам нужно использовать "поиск" на вашем диске, что-то не так с управлением проектами )
• разбить коды на короткие модули для локализации и более короткие коды, с меньшей прокруткой, коды будут легче отслеживать.
• использовать значащие переменные и имена функций (стиль java кажется приятным, например, "backedupDataForVerification" ), не ограничивайте, чтобы сократить слова, вы будете страдать позже
• при проектировании, подумайте, следует ли использовать функцию, скриптинг или OO (объектно-ориентированный)
• Не спешите с преждевременной оптимизацией, поскольку скорость Matlab - не лучший выбор. Если вам действительно нужно, не сохраняйте ни одну оптимизированную версию для сопоставления со стороны на стороне, устранение неполадок и отладка не будут меньше проклятия.
• Всегда, всегда, всегда комментируйте свои коды. Никогда не используйте оправдание тому, что у вас нет времени, вы потеряете больше времени.

• для дифференцирования, рассмотрите возможность установки нового node для модификации кода, например. установите дерево, чтобы отличать версии.

• используйте отдельную папку для входов/выходов, изображений, промежуточных результатов и т.д.

• использовать временную метку для отслеживания версий

• делитесь своими кодами с кем-то другим, если им сложно поддерживать, использовать или модифицировать, переосмыслить, как уточнить ваши сборки.

Назад все правильно. Создайте первоначальный tarball исходного исходного дерева, а затем бросьте все это в исходное управление, чтобы вы могли отслеживать и откатывать свои изменения.

Посмотрите на Matlab depfun() и depdir(), которые обнаруживают статические зависимости. Это может помочь вам увидеть зависимости между функциями Matlab. С "depfun -toponly" во всех файлах и небольшим перетасовкой строк вы можете создать список непосредственных зависимостей и бросить это в файле GraphViz, чтобы создать большой ориентированный граф ваших кодовых подключений. Кластеры на графике могут быть хорошим местом для разделения кода. (EDIT: см. Решение Jonas, похоже, что m2html делает это для вас.)

Если у вас есть большая свобода для перезаписи кода, подумайте о том, чтобы переписать часть кода как объекты, используя классы утилиты без состояния с методами класса и частными функциями в качестве способов объединения связанных функций и обеспечения некоторой инкапсуляции. Я работал с довольно большими кодовыми базами Matlab, организованными таким образом, и все работает. В классическом Matlab классы - это ваш единственный способ сделать какие-то пакеты. Я считаю, что новая система OO Matlab также поддерживает пространство имен.

Если вы не хотите конвертировать код в OO, вы можете организовать связанные функции в подкаталогах. Это помогает организовать его для просмотра исходного кода, по крайней мере.

Все функции должны иметь некоторую doco в стандартном формате hellext Matlab, включая строку H1. Если они этого не сделают, напишите комментарии о том, что вы там узнали. Затем используйте инструмент "contentrpt" для автоматического создания файлов оглавления для классов или каталогов.

Удачи.

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

Организуйте исходные файлы в иерархию каталогов, как и исходные файлы для любой программы, написанной на другом языке программирования. Вам не нужно придерживаться иерархии, если хотите, выберите свою структуру. Используйте команду setpath (или что бы там ни говорилось), чтобы сообщить Matlab, где искать ваши файлы m, когда вы работаете.

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

Конечно, все наши файлы m находятся в репозитории, и мы их обслуживаем. Мы держим частный инструментарий на одном из наших сетевых дисков, и все пользователи могут напрямую вызвать "выпущенный" код в этом ящике инструментов.