Объяснение [[nodiscard]] в C++17

Идея состоит в том, что если имеет смысл вызывать вашу функцию только тогда, когда вы также принимаете ее возвращаемое значение, вызов ее без получения возвращаемого значения является ошибкой программирования. Аннотация [[nodiscard]] помогает программистам, взаимодействующим с вашим кодом, избежать этой ошибки.

В вашем конкретном примере ваша функция вычисляет результат без побочных эффектов, поэтому статический анализатор кода понимает, что это хорошо подходит для [[nodiscard]]. Например:

Test a;
auto x = a.f(1, 2); // ok
std::cout << "For 1, 2 we get " << a.f(1,2) << std::endl; // also ok
a.f(1, 2); // warning here

Здесь компилятору рекомендуется в последней строке предупреждать о вызове функции без дальнейшей обработки результата.

Обсуждение

Примером хорошего использования [[discard]] могут быть методы объекта, которые манипулируют объектом, но предоставляют результат в виде копии. Пример:

DateTime yesterday = DateTime.now().substractOneDay();
std::cout << "Yesterday was " << yesterday.nameOfDay() << std::endl;

против:

DateTime yesterday = DateTime.now();
yesterday.substractOneDay();
std::cout << "Yesterday was " << yesterday.nameOfDay() << std::endl;

[[nodiscard]] сообщит программисту второго примера, что он использует его неправильно.

[[nodiscard]] полезен, когда у вас есть методы класса, которые что-то возвращают, и вы хотите подчеркнуть, что метод не работает на месте, а вместо этого что-то возвращает.
Например, если у вас есть связанный список, возможный метод reverse может быть помечен [[nodiscard]], чтобы сигнализировать о том, что метод возвращает новый список.

Это помогает избежать такого кода:

List l{1, 2, 3, 4};
l.reverse();
std::cout << l;

>> 1, 2, 3, 4 //Why is this not working?

Мне кажется, что наиболее полезно использовать [[nodiscard]], когда у вас есть метод/функция, которая изменяет объект/параметры, но также что-то возвращает (поэтому метод/функция не может быть константой).

List l{1, 2, 3, 4};
l.doubleEveryElementAndSum(); //the sum returned is silently ignored
std::cout << l;

>> 2, 4, 6, 8

Тот факт, что CLion выделяет метод и сообщает, что метод может быть помечен [[nodiscard], не имеет ничего общего ни с CLion, ни с компилятором, а с инструментом clang-tidy. Этот инструмент сканирует ваш код и проверяет, что можно улучшить, а затем CLion визуализирует результаты этого инструмента.
Когда вы компилируете свой код, компилятор будет читать аннотацию и выдавать предупреждение всякий раз, когда он находит код, который игнорирует возвращаемое значение функции, отмеченной [[nodiscard]].

Я предлагаю не загрязнять ваш код, ставя везде [[nodiscard]], как предлагает CLion (clang-tidy). Если вас раздражают предупреждения, вы можете отключить их в настройках clang-tidy.

Нет, в данном случае эта аннотация не нужна.

Предложение добавить его поступило от вашего текстового редактора. Ваш текстовый редактор не является компилятором C++. Только компилятор C++ полностью понимает исходный код C++. Ваш текстовый редактор C++ просто имеет несколько простых правил для добавления предложений, которые, по его мнению, могут быть полезны для улучшения кода. Конкретная причина, по которой он мог показать это предложение, является простым предположением, не зная точно, что делает логика вашего текстового редактора.

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

Ключевое слово там "должны". Игнорирование значений, возвращаемых функциями или методами класса, не является ошибкой. Это само по себе не делает код плохо сформированным. Это правда, что в некоторых случаях игнорирование возвращаемых значений может привести к проблемам. Но для этого должны вступить в силу другие факторы. Например, игнорирование возвращаемого значения из read() и блаженное предположение, что что-то действительно было прочитано из файла или сокета, почти всегда является ошибкой.