codeCompatibilityReport

Создайте отчет о совместимости кода

Описание

пример

codeCompatibilityReport создает отчет о совместимости кода для текущей рабочей папки и подпапок. В MATLAB откроется отчет о совместимости кода® Веб-браузер. После обновления до более новой версии MATLAB можно использовать этот отчет для выявления потенциальных проблем совместимости в существующем коде.

codeCompatibilityReport(names) создает отчет для файлов или папок, заданных names.

codeCompatibilityReport(___,'IncludeSubfolders',tf) определяет, следует ли создавать отчеты по подпапкам. По умолчанию подпапки включаются в анализ. Используйте этот синтаксис с любым из аргументов в предыдущих синтаксисах.

пример

codeCompatibilityReport(cca) создает отчет из существующего результата совместимости кода, заданного как CodeCompatibilityAnalysis объект.

Примеры

свернуть все

Создайте отчет о совместимости кода для кода в текущей папке и подпапках. Отчет откроется в веб-браузере MATLAB.

codeCompatibilityReport

Создайте другой отчет, но пропустите подпапки из анализа.

codeCompatibilityReport('IncludeSubfolders',false)

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

r = analyzeCodeCompatibility;

Создайте отчет из результатов. Отчет откроется в веб-браузере MATLAB.

codeCompatibilityReport(r)

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

свернуть все

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

Имя файла должно быть допустимым кодом MATLAB или файлом приложения (.m, .mlx, или .mlapp).

Пример: '../thisFile.m'

Пример: {'folderA','folderB','fileA'}

Типы данных: char | string

Индикатор анализа подпапок, заданный как true, false, 0 или 1. По умолчанию, analyzeCodeCompatibility включает подпапки в анализ. Чтобы исключить подпапки, установите tf на false или 0.

Результаты анализа совместимости кода, заданные как CodeCompatibilityAnalysis объект.

Подробнее о

свернуть все

Отчет о совместимости кода

Отчет о совместимости кода содержит информацию, которая поможет вам обновить код до новой версии MATLAB. В нем содержатся эти разделы.

  • Syntax Errors - Таблица с подробностями об ошибках синтаксиса. Для примера Использование ~ для игнорирования значения не разрешено в этом контексте. Синтаксические ошибки приводят к невосполнимому коду и, хотя они не представлены в новой версии MATLAB, синтаксические ошибки влияют на анализ совместимости.

    Таблица включает эту информацию.

    Столбец отчетаОписание
    ВхожденияОбщее количество синтаксических ошибок в файле.
    Имя файлаИмя файла, содержащего синтаксические ошибки.

  • Functionality that has been removed - Таблица с подробностями о функциональности, которая используется в анализируемом коде и которая была удалена. Для примера 'wavfinfo' был удален. Вместо этого используйте 'AUDIOINFO'.

    Таблица включает эту информацию.

    Столбец отчетаОписание

    Описание

    Описание проверки. Описание аналогично сообщению анализатора кода.

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

    Ссылка на дополнительную информацию в документации.

    Удалено вРелиз, в котором была удалена функциональность.
    Имя файлаИмя файла, содержащего помеченную проверку.
    ЛинияНомер строки, указывающий местоположение в файле маркированной проверки.

  • Functionality that has changed behavior - Таблица с подробностями о функциональности, которая используется в анализируемом коде и которая изменила поведение. Например, 'legend' изменилась и может интерпретировать имя аргумента как свойство легенды вместо метки. Чтобы включить метку с тем же именем, что и свойство legend, задайте метки с помощью массива ячеек или строковых массивов. Список затронутых имен свойства см. в документации.

    Таблица включает эту информацию.

    Столбец отчетаОписание

    Описание

    Описание проверки. Описание аналогично сообщению анализатора кода.

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

    Ссылка на дополнительную информацию в документации.

    Влияет на код, написанный доРелиз, в котором была изменена функциональность.
    Имя файлаИмя файла, содержащего помеченную проверку.
    ЛинияНомер строки, указывающий местоположение в файле маркированной проверки.

  • Unsupported functionality that might cause errors - Перечисленные здесь файлы используют функциональность, которая не поддерживается, не имеет документов и не предназначена для использования клиентами. Обновите код, чтобы использовать документированные функции, чтобы избежать ошибок и неожиданных изменений поведения. Например, 'awtinvoke' не поддерживается и может быть изменен или удален без уведомления. С соответствующими изменениями кода используйте javaMethodEDT вместо этого.

    Таблица включает эту информацию.

    Столбец отчетаОписание

    Описание

    Описание проверки. Описание аналогично сообщению анализатора кода.

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

    Ссылка на дополнительную информацию в документации.

    Имя файлаИмя файла, содержащего помеченную проверку.
    ЛинияНомер строки, указывающий местоположение в файле маркированной проверки.

  • Functionality that will be removed - Таблица с подробностями о функциональности, которая используется в анализируемом коде и которая будет удалена в будущем релизе. Для примера 'aviinfo' будет удалено в будущем релизе. Вместо этого используйте 'VideoReader'.

    Таблица включает эту информацию.

    Столбец отчетаОписание

    Описание

    Описание проверки. Описание аналогично сообщению анализатора кода.

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

    Ссылка на дополнительную информацию в документации.

    Имя файлаИмя файла, содержащего помеченную проверку.
    ЛинияНомер строки, указывающий местоположение в файле маркированной проверки.

  • Functionality that will change behavior - Таблица с подробностями о функциональности, которая используется в анализируемом коде и которая изменит поведение в будущем релизе. Например, 'interp1 (...,' cubic ')' изменится в будущем релизе, чтобы выполнить кубическую свертку. Чтобы продолжить использование кусочно-кубической интерполяции с сохранением формы, используйте 'interp1 (...,' pchip ')' вместо этого.

    Таблица содержит те же столбцы, что и в Functionality that will be removed разделе.

  • New functionality that might improve code - Рассмотрите обновление вашего кода. Ожидается, что текущий код продолжит работу в будущих релизах, но рекомендуется использовать более новые функциональные возможности. Для примера программное использование ОТОБРАЖЕНИЯ не рекомендуется. Вместо этого используйте DISP или FPRINTF.

    Таблица включает эту информацию.

    Столбец отчетаОписание

    Описание

    Описание проверки. Описание аналогично сообщению анализатора кода.

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

    Ссылка на дополнительную информацию в документации.

    Имя файлаИмя файла, содержащего помеченную проверку.
    ЛинияНомер строки, указывающий местоположение в файле маркированной проверки.
    ПодавлениеПодавляется ли и как эта проверка в редакторе. Значение None указывает, что проверка не подавлена.

  • Full list of checks performed - Таблица с информацией о проверках, выполненных по указанному коду. Он включает следующую информацию.

    Столбец отчетаОписание

    Вхождения

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

    Файлы

    В проанализированном коде количество файлов, в которых отмечена конкретная проверка.

    Описание

    Описание проверки. Например, используйте новую строку, точку с запятой или запятую перед оператором или STRMATCH не рекомендуется. Вместо этого используйте STRNCMP или VALIDATESTRING. Описание аналогично сообщению анализатора кода.

    Серьезность

    Степень серьезности проверки. Для примера, Error или Warning. Ошибки могут указывать на синтаксические ошибки или использование функций, которые больше не поддерживаются. Предупреждения могут указывать на возможности улучшить ваш код.

    Идентификатор

    Идентификатор для сообщений анализатора кода MATLAB.

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

    Ссылка на дополнительную информацию в документации.

  • Full list of files analyzed - Список файлов, которые MATLAB проанализировал на совместимость кода.

Совет

Альтернативы

Сгенерируйте Отчет о совместимости кода для кода в текущей рабочей папке и подпапках в браузере Текущей папки. В браузере Текущей папки щелкните или щелкните правой кнопкой по пустому пространству. Затем выберите Reports > Code Compatibility Report. См. отчет о совместимости кода MATLAB.

Введенный в R2017b