exponenta event banner

addLabel

Прикрепить метку к файлу проекта

Описание

пример

addLabel(file,categoryName,labelName) присоединяет указанную метку в указанной категории к указанному файлу.

пример

addLabel(file,categoryName,labelName,labelData) добавляет метку с указанными текстовыми или числовыми данными. Нельзя добавлять данные меток во встроенные метки, поскольку они доступны только для чтения.

Примеры

свернуть все

Откройте проект приложения Times Table. Использовать currentProject для создания объекта проекта из загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

Получить файл по имени.

myfile = findFile(proj,"source/timesTableGame.m")
mmyfile = 

  ProjectFile with properties:

                   Path: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×1 matlab.project.Label]
               Revision: "286043ae7ee557100902fb645a6c97eca5d50472"
    SourceControlStatus: Unmodified

Просмотреть существующую метку, получив Labels свойства файла.

myfile.Labels
ans = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Design"
    CategoryName: "Classification"

Прикрепить этикетку "Artifact" в файл в категории "Classification".

addLabel(myfile,"Classification","Artifact")
ans = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Artifact"
    CategoryName: "Classification"

Теперь есть две метки, исходная и добавленная. Чтобы просмотреть только добавленное, выполните индексирование в Labels собственность.

reviewlabel = myfile.Labels(1)
reviewlabel = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Artifact"
    CategoryName: "Classification"

Отсоедините новую метку от файла. Файл теперь имеет только одну метку.

removeLabel(myfile,reviewlabel)
myfile
myfile = 

  ProjectFile with properties:

                   Path: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×0 matlab.project.Label]
               Revision: "286043ae7ee557100902fb645a6c97eca5d50472"
    SourceControlStatus: Unmodified

Прикрепить этикетку "Utility" в "Classification" категории для всех файлов в проекте, имеющих .m расширение файла.

Откройте проект приложения Times Table. Использовать currentProject для создания объекта проекта из загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

Получите список файлов.

files = proj.Files;

Закольцовывайте каждый файл. Чтобы получить только расширение файла, используйте fileparts и возьмите последнюю часть. Если файл имеет расширение .m, прикрепить этикетку "Utility".

for fileIndex = 1:numel(files)
   file = files(fileIndex);
   [~, ~, fileExtension] = fileparts(file.Path);
   if strcmp(fileExtension,".m")
       addLabel(file,"Classification","Utility");
   end
end

На виде «Файлы проекта» в столбце «Классификация» отображается метка Utility для каждого .m в файле utilities папка.

Создание категории меток "Review" и метку «To Review», а затем прикрепите метку и данные метки к файлу. Нельзя добавлять данные меток во встроенные метки, поскольку они доступны только для чтения.

Откройте проект приложения Times Table. Использовать currentProject для создания объекта проекта из загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

Создание новой категории "Review".

createCategory(proj,"Review","char");

Для новой категории создайте метку "To Review".

reviewCategory = findCategory(proj,"Review");
createLabel(reviewCategory,"To Review");

Получить файл по имени.

myfile = findFile(proj,"source/timesTableGame.m")
myfile = 

  ProjectFile with properties:

                   Path: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×1 matlab.project.Label]
               Revision: "c7603d5dd71a40484974c3f1c45d839819b7b061"
    SourceControlStatus: Unmodified

Прикрепить этикетку "To Review" и символьный вектор данных метки для файла.

addLabel(myfile,"Review","To Review","Whole team design review")
ans = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'char'
            Data: 'Whole team design review'
            Name: "To Review"
    CategoryName: "Review"

В представлении «Файлы проекта» для timesTableGame.m в столбце «Проверка» отображается To Review метка с данными метки.

Кроме того, можно задать или изменить данные метки с помощью Data собственность.

mylabel = myfile.Labels(1);
mylabel.Data = "Final review";

Входные аргументы

свернуть все

Файл для метки, указанный как ProjectFile объект. Вы можете получить ProjectFile путем проверки свойства Files проекта (proj.Files) или с помощью findFile для поиска файла по имени. Файл должен находиться в проекте.

Имя категории для метки, указанное как вектор символа или скаляр строки.

Имя присоединяемой метки, указанное как вектор символа, скаляр строки или как LabelDefinition объект, возвращенный file.Label свойства или findLabel функция. Можно указать новое имя метки, которое еще не существует в проекте.

Данные для присоединения к метке, указанные как вектор символов, скаляр строки или числовое значение. Тип данных зависит от определения метки. Получить этикетку для проверки ее DataType свойство с использованием file.Label или findLabel.

Представлен в R2019a