matlab.project.Project

Описание

The matlab.project.Project объект представляет загруженный проект. Объект проекта используется для запроса загруженного проекта и выполнения на нем различных операций.

Создание

Как создать matlab.project.Project объект, использовать currentProject функция, чтобы получить открытый проект. Для примера:

proj = currentProject;
Если проект в данный момент не открыт, используйте openProject функция для загрузки существующего проекта. Для примера:
proj = openProject("C:/projects/project1/");

Свойства

расширить все

Имя проекта, заданное как строка.

Пометьте категории для проекта, заданные как массив Category объекты.

Файлы ярлыков для проекта, заданные как массив Shortcut объекты.

Проецируйте папки пути, которые добавляются в MATLAB® путь, заданный как массив PathFolder объекты.

Пути к ссылкам на проекты, заданные как массив ProjectReference объекты.

Пути к файлам проекта, заданные как массив ProjectFile объекты.

Проецируйте корневую папку, заданную как строка. RootFolder включает полный путь корня проекта.

Функции объекта

расширить все

closeЗакрыть проект
exportЭкспорт проекта в архив
isLoadedОпределите, загружен ли проект
reloadПерезагрузка проекта
addFileДобавить файл или папку в проект
addFolderIncludingChildFilesДобавьте папку и дочерние файлы к проекту
removeFileУдалить файл из проекта
addPathДобавить папку в путь проекта
removePathУдалите папку из пути проекта
addReferenceДобавьте ссылку на проект
removeReferenceУдалить ссылку на проект
addStartupFileДобавьте файл запуска к проекту
addShutdownFileДобавьте файл завершения работы в проект
removeStartupFileУдалите файл запуска из списка запуска проекта
removeShutdownFileУдалите файл завершения работы из списка завершения проекта
addShortcutДобавьте ярлык к проекту
removeShortcutУдалите ярлык из проекта
addLabelПрикрепить метку к файлу проекта
createLabelСоздайте метку проекта
removeLabelУдалить метку из проекта
findLabelПолучите метку файла проекта
createCategoryСоздание категории меток проекта
findCategoryНайти категорию проекта меток
removeCategoryУдаление категории проекта меток
findFileПоиск файла проекта по имени
listModifiedFilesСписок измененных файлов в проекте
listRequiredFilesПолучите файлы, необходимые для заданных файлов проекта
refreshSourceControlОбновление состояния системы контроля версий файлов проекта
updateDependenciesОбновление зависимостей проекта

Примеры

свернуть все

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

matlab.project.example.timesTable
proj = currentProject
proj = 

  Project with properties:

                        Name: "Times Table App"
    SourceControlIntegration: "Git"
          RepositoryLocation: "C:\myProjects\examples\repositories\TimesTableApp"
       SourceControlMessages: ["No remote tracking branch" "Branch status: Normal" ...
                    ReadOnly: 0
                    TopLevel: 1
                Dependencies: [1×1 digraph]
                  Categories: [1×1 matlab.project.Category]
                       Files: [1×14 matlab.project.ProjectFile]
                   Shortcuts: [1×4 matlab.project.Shortcut]
                 ProjectPath: [1×3 matlab.project.PathFolder]
           ProjectReferences: [1×0 matlab.project.ProjectReference]
                StartupFiles: [1×0 string]
               ShutdownFiles: [1×0 string]
                 Description: "This example project contains the source code and tests ...
                  RootFolder: "C:\myProjects\examples\TimesTableApp"
        ProjectStartupFolder: "C:\myProjects\examples\TimesTableApp"

Откройте проект Times Table App и создайте объект проекта.

matlab.project.example.timesTable
proj = currentProject;

Найдите функции, которые можно выполнить на объекте проекта.

methods(proj)
Methods for class matlab.project.Project:

addFile                       listModifiedFiles             
addFolderIncludingChildFiles  listRequiredFiles             
addPath                       refreshSourceControl          
addReference                  reload                        
addShortcut                   removeCategory                
addShutdownFile               removeFile                    
addStartupFile                removePath                    
addprop                       removeReference               
close                         removeShortcut                
createCategory                removeShutdownFile            
export                        removeStartupFile             
findCategory                  updateDependencies            
findFile                      
isLoaded                      

Получите объект проекта и исследуйте его свойства.

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

matlab.project.example.timesTable
proj = currentProject;

Исследуйте файлы проекта.

files = proj.Files
files = 

  1×14 ProjectFile array with properties:

    Path
    Labels
    Revision
    SourceControlStatus

Исследуйте метки 13-го файла.

proj.Files(13).Labels
ans = 

  Label with properties:

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

Получите конкретный файл по имени.

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: ""
    SourceControlStatus: Unmodified

Узнайте, что можно сделать с файлом.

methods(myfile)
Methods for class matlab.project.ProjectFile:

addLabel     findLabel    removeLabel  
Введенный в R2019a
Для просмотра документации необходимо авторизоваться на сайте