Exponenta Banner
exponenta event banner

MISRA C++: 2008 Правило 2-7-2

Разделы кода не должны быть «прокомментированы» с помощью комментариев в стиле Си

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

Описание

Определение правила

Разделы кода не должны быть «прокомментированы» с помощью комментариев типа С.

Объяснение

Комментарии в стиле C, содержащиеся в /* */ не поддерживают вложение. Комментарий, начинающийся с /* заканчивается на первом */ даже когда */ представляет собой конец более позднего вложенного комментария. Если раздел кода, который комментируется, уже содержит комментарии, вы можете столкнуться с ошибками компиляции (или, по крайней мере, прокомментировать меньше кода, чем вы предполагаете).

Комментирование кодекса не является хорошей практикой. Код с комментариями может не синхронизироваться с окружающим кодом, не вызывая ошибок компиляции. Позже, если вы раскомментируете код, вы можете столкнуться с неожиданными проблемами.

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

Внедрение Polyspace

Средство проверки использует внутреннюю эвристику для обнаружения комментированного кода. Например, такие символы, как #, ;, { или } укажите комментарии, которые потенциально могут содержать код. Эти комментарии затем оцениваются по другим метрикам, чтобы определить вероятность маскировки кода как комментария. Например, несколько последовательных слов без символа между ними уменьшают эту вероятность.

Средство проверки не помечает следующие комментарии, даже если они содержат код:

  • Комментарии Doxygen начинаются с /** или /*!.

  • Комментарии, повторяющие один и тот же символ несколько раз, например символ = здесь:

    /* =====================================
 * A comment
 * =====================================*/

  • Комментарии к первой строке файла.

  • Комментарии, сочетающие стиль C (/* */) и стиль C++ (//).

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

Поиск неисправностей

Если вы ожидаете нарушения правила, но не видите его, обратитесь к разделу Нарушения стандартов кодирования не отображаются.

Примеры

развернуть все

#include <iostream>
/* class randInt {//Noncompliant
    public: 
      int getRandInt();
};
*/

int getRandInt();

/* Function to print random integers*/ 
void printInteger() {
    /* int val = getRandInt();//Noncompliant 
     * val++; 
     * std::cout << val;*/     
    std::cout << getRandInt();
}

Этот пример содержит два блока кода с комментариями, что составляет два нарушения правил.

Проверить информацию

Группа: Лексические конвенции
Категория: Обязательно

См. также

Темы

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

Документация по программе проверки кода Polyspace

Поддержка