Как переопределить текст по умолчанию в MATLAB - PullRequest
6 голосов
/ 31 марта 2010

В MATLAB, когда вы нажимаете Файл -> Создать -> Функция M-File, вы получаете файл со следующим содержимым:

function [ output_args ] = Untitled( input_args )
%UNTITLED Summary of this function goes here
%   Detailed explanation goes here


end

Можно ли переопределить это поведение и указать свой собственный текст?

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

Ответы [ 4 ]

6 голосов
/ 31 марта 2010

Я даже не знал, что Файл-> Новый-> Функция это сделала.

Я решил проблему, написав функцию, которую вы вызываете через

>>newFunction myNewFunctionName

Это потом

  1. выскакивает окно inputdlg, которое запрашивает у пользователя синопсис и строку H1 и позволяет уже написать справку для объяснения входных и выходных аргументов. Там пользователь также выбирает, является ли myNewFunctionName функцией или классом, чтобы выбрать правильный заголовок и «вызов функции»
  2. проверяет, существует ли уже функция с таким же именем
  3. запрашивает папку для сохранения функции и
  4. открывает функцию в редакторе

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

EDIT Для новых классов функция шаблона автоматически удостоверяется, что они подклассируют мой общий суперкласс, который реализует такие методы, как 'help' (который вызывает doc(class(obj)))

Теперь, если функция шаблона также напишет часть алгоритма функции, это будет действительно удобно. :)

EDIT2 Здесь - ссылка на функцию обмена файлами.

2 голосов
/ 31 марта 2010

Я бы предложил создать собственный шаблон m-файла по умолчанию, например, с именем default.m, и поместить его в папку по пути MATLAB , где ваши коллеги смогут получить к нему доступ. Затем вы должны установить файл только для чтения. Ваши коллеги могут затем выполнить любую из следующих команд в командном окне MATLAB, когда они хотят создать новый m-файл функции:

open default.m
open('default.m')
edit default.m
edit('default.m')

Функции OPEN и EDIT откроют файл в редакторе MATLAB. Поскольку файл default.m доступен только для чтения, если кто-то попытается сохранить его, он получит диалоговое окно, предупреждающее их об этом и предлагающее сохранить его в новый файл (или перезаписать его). Это должно предотвратить случайное изменение шаблона.

1 голос
/ 31 марта 2010

Я просмотрел все текстовые файлы, начиная с папки matlabroot, но не смог найти этот шаблон. Кажется, это жестко запрограммировано, что странно.

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

0 голосов
/ 12 апреля 2010

После долгих размышлений я нашел решение, которым я доволен, объединяя ответы Джонаса и Гновице. Это функция, которая создает новый m-файл (с документацией шаблона) и открывает его в редакторе. Он доступен в Matlab Central Файловый обмен .

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...