addLabel

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

Свернуть все на странице

Синтаксис

addLabel(file,categoryName,labelName)
addLabel(file,categoryName,labelName,labelData)

Описание

пример

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

пример

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

Примеры

свернуть все

Откройте проект Times Table App. Использовать 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 App. Использовать currentProject чтобы создать объект проекта из загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

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

files = proj.Files;

Цикл через каждый файл. Чтобы получить только расширение файла, используйте fileparts function и take the last part. если файл имеет расширение .m, присоедините метку "Utility".

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

В представлении Files проекта в столбце Classification отображается метка Utility для каждого .m файл в utilities папка.

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

Откройте проект Times Table App. Использовать 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"

В представлении Files проекта для timesTableGame.m файл, в Review столбце отображается To Review метка с данными о метке.

Также можно задать или изменить данные о метках с помощью Data свойство.

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

Входные параметры

свернуть все

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

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

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

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

См. также

| | | | |

Темы

Введенный в R2019a

Документация MATLAB

Поддержка

Для просмотра документации необходимо авторизоваться на сайте