# V2587. MISRA. The '//' and '/*' character sequences should not appear within comments.

Данное диагностическое правило основано на руководстве MISRA (Motor Industry Software Reliability Association) по разработке программного обеспечения.

Это правило актуально только для C. Внутри комментариев не должна присутствовать последовательность символов, которая обозначает начало комментария. Такое возможно, если блок комментариев не был закрыт последовательностью '*/' либо блок кода был закомментирован построчно через '//'.

Рассмотрим первый пример:

    /* this comment is not closed
    some_critical_function();
    /* We're still inside the comment */

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

Подобная проблема может происходить при использовании однострочных комментариев. Рассмотрим второй пример:

    int some_function(int x, int y)
    {
        return x // /*
                   + y
                 // */
                ;
    }

Однострочный комментарий подавляет многострочный, и из-за этого итоговое выражение будет таким:

    return x + y;

вместо:

    int x = y;

Анализатор не выдает срабатывание, если последовательность '//' встречается внутри однострочного комментария:

    ....
    // some_unecessary_call_1(); // probably, should not do this
    // some_unecessary_call_2(); // probably, should not do this too
    ....

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

Данная диагностика классифицируется как:

MISRA-C-2012-3.1 MISRA-C-2023-3.1